com.ptc.core.ca.co.client.frame
Class CoFrame

java.lang.Object
  com.ptc.core.ca.co.client.element.CoElement
      com.ptc.core.ca.co.client.frame.CoFrame

All Implemented Interfaces:

CoAddressable, CoCleanable, CoContainer, com.ptc.core.ca.co.client.element.CoModeDriven, CoModelDriven, Externalizable, Serializable

Direct Known Subclasses:

CoCompositeFrame, CoSimpleFrame

Deprecated.

@Deprecated
public abstract class CoFrame
extends CoElement
implements CoContainer, com.ptc.core.ca.co.client.element.CoModeDriven, CoModelDriven, CoCleanable, Externalizable

This class defines the conceptual frame element. It represents a window in a conceptual environment.

Frame element has absolutely no connection to HTML frame.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ptc.core.ca.co.client.element.CoContainer

CHILDREN

Fields inherited from interface com.ptc.core.ca.co.client.element.CoCleanable

DIRTY

Fields inherited from interface com.ptc.core.ca.co.client.address.CoAddressable

ADDRESS

Method Summary

CoElement	createDynamicSubElement(String typeId, CoEnvData envData) Deprecated. Creates a static sub-element.
CoElement	createStaticSubElement(CoConfigFeature subElementConfiguration, CoEnvData envData) Deprecated. Creates a static sub-element.
Map	getAnyData() Deprecated. Gets the value of the attribute: anyData; the map with frame scope.
Map	getChildren() Deprecated. Gets the value of the attribute: children; the map of child elements.
CoModel	getModel() Deprecated. Gets the object for the association that plays role: model; the model of the element Supported API: true
String	getOpenerActionAddress() Deprecated. Gets the value of the attribute: openerActionAddress; the external form of the address of the action that was triggered to create this frame.
boolean	isBeingHandled() Deprecated. Gets the value of the attribute: beingHandled; the flag indicating whether the frame is in the process of being handled by the framework.
boolean	isBeingRefreshed() Deprecated. Gets the value of the attribute: beingRefreshed; the flag indicating whether the frame is in the process of being refreshed.
boolean	isDirty() Deprecated. Gets the value of the attribute: dirty; the flag indicating whether the element is out of date.
void	pruneChildren(CoEnvData envData) Deprecated. Removes sub-elements that do not have to be maintained and can easily be restored during new drawing.
void	setAnyData(Map a_AnyData) Deprecated. Sets the value of the attribute: anyData; the map with frame scope.
void	setBeingHandled(boolean a_BeingHandled) Deprecated. Sets the value of the attribute: beingHandled; the flag indicating whether the frame is in the process of being handled by the framework.
void	setBeingRefreshed(boolean a_BeingRefreshed) Deprecated. Sets the value of the attribute: beingRefreshed; the flag indicating whether the frame is in the process of being refreshed.
void	setChildren(Map a_Children) Deprecated. Sets the value of the attribute: children; the map of child elements.
void	setDirty(boolean a_Dirty) Deprecated. Sets the value of the attribute: dirty; the flag indicating whether the element is out of date.
void	setModel(CoModel a_Model) Deprecated. Sets the object for the association that plays role: model; the model of the element Supported API: true
void	setOpenerActionAddress(String a_OpenerActionAddress) Deprecated. Sets the value of the attribute: openerActionAddress; the external form of the address of the action that was triggered to create this frame.
void	updateModel(CoEnvData envData) Deprecated. Creates and updates the model of the element.

Methods inherited from class com.ptc.core.ca.co.client.element.CoElement

canBePruned, default_draw, default_init, draw, getAddress, getConfiguration, getFrame, getParent, handleDrawError, render, setAddress, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ptc.core.ca.co.client.element.CoContainer

updateChildren

Method Detail

isBeingHandled

public boolean isBeingHandled()

Deprecated.

Gets the value of the attribute: beingHandled; the flag indicating whether the frame is in the process of being handled by the framework. This can be when, for instance, the frame is drawn.

Supported API: true

Returns:

boolean

setBeingHandled

public void setBeingHandled(boolean a_BeingHandled)

Deprecated.

Sets the value of the attribute: beingHandled; the flag indicating whether the frame is in the process of being handled by the framework. This can be when, for instance, the frame is drawn.

Supported API: true

Parameters:

a_BeingHandled -

isBeingRefreshed

public boolean isBeingRefreshed()

Deprecated.

Gets the value of the attribute: beingRefreshed; the flag indicating whether the frame is in the process of being refreshed. The user usually triggers refresh using environment dependent means.

Supported API: true

Overrides:

isBeingRefreshed in class CoElement

Returns:

boolean

setBeingRefreshed

public void setBeingRefreshed(boolean a_BeingRefreshed)

Deprecated.

Sets the value of the attribute: beingRefreshed; the flag indicating whether the frame is in the process of being refreshed. The user usually triggers refresh using environment dependent means.

Supported API: true

Parameters:

a_BeingRefreshed -

getOpenerActionAddress

public String getOpenerActionAddress()

Deprecated.

Gets the value of the attribute: openerActionAddress; the external form of the address of the action that was triggered to create this frame.

Supported API: true

Returns:

String

setOpenerActionAddress

public void setOpenerActionAddress(String a_OpenerActionAddress)

Deprecated.

Sets the value of the attribute: openerActionAddress; the external form of the address of the action that was triggered to create this frame.

Supported API: true

Parameters:

a_OpenerActionAddress -

getAnyData

public Map getAnyData()

Deprecated.

Gets the value of the attribute: anyData; the map with frame scope. Can be used for communication between elements on the same frame.

Supported API: true

Returns:

Map

setAnyData

public void setAnyData(Map a_AnyData)

Deprecated.

Sets the value of the attribute: anyData; the map with frame scope. Can be used for communication between elements on the same frame.

Supported API: true

Parameters:

a_AnyData -

updateModel

public void updateModel(CoEnvData envData)
                 throws WTException

Deprecated.

Creates and updates the model of the element.

Supported API: true

Specified by:

updateModel in interface CoModelDriven

Parameters:

envData -

Throws:

WTException

createStaticSubElement

public CoElement createStaticSubElement(CoConfigFeature subElementConfiguration,
                                        CoEnvData envData)
                                 throws WTException

Deprecated.

Creates a static sub-element. Sub-element is considered to be static when its existence is solely defined by the configuration specification.

Supported API: true

Parameters:

subElementConfiguration -

envData -

Returns:

CoElement

Throws:

WTException

createDynamicSubElement

public CoElement createDynamicSubElement(String typeId,
                                         CoEnvData envData)
                                  throws WTException

Deprecated.

Creates a static sub-element. Sub-element is considered to be static when its existence is solely defined by the configuration specification.

Supported API: true

Parameters:

typeId -

envData -

Returns:

CoElement

Throws:

WTException

pruneChildren

public void pruneChildren(CoEnvData envData)
                   throws WTException

Deprecated.

Removes sub-elements that do not have to be maintained and can easily be restored during new drawing.

Supported API: true

Specified by:

pruneChildren in interface CoContainer

Parameters:

envData -

Throws:

WTException

getChildren

public Map getChildren()

Deprecated.

Gets the value of the attribute: children; the map of child elements. Adresses of child elements CoAddress are used as keys.

Supported API: true

Specified by:

getChildren in interface CoContainer

Returns:

Map

setChildren

public void setChildren(Map a_Children)

Deprecated.

Sets the value of the attribute: children; the map of child elements. Adresses of child elements CoAddress are used as keys.

Supported API: true

Specified by:

setChildren in interface CoContainer

Parameters:

a_Children -

getModel

public CoModel getModel()

Deprecated.

Gets the object for the association that plays role: model; the model of the element

Supported API: true

Specified by:

getModel in interface CoModelDriven

Returns:

CoModel

setModel

public void setModel(CoModel a_Model)

Deprecated.

Sets the object for the association that plays role: model; the model of the element

Supported API: true

Specified by:

setModel in interface CoModelDriven

Parameters:

a_Model -

isDirty

public boolean isDirty()

Deprecated.

Gets the value of the attribute: dirty; the flag indicating whether the element is out of date.

Supported API: true

Specified by:

isDirty in interface CoCleanable

Returns:

boolean

setDirty

public void setDirty(boolean a_Dirty)

Deprecated.

Sets the value of the attribute: dirty; the flag indicating whether the element is out of date.

Supported API: true

Specified by:

setDirty in interface CoCleanable

Parameters:

a_Dirty -