com.ptc.core.ca.co.client.element
Class CoElement

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

All Implemented Interfaces:

CoAddressable, Externalizable, Serializable

Direct Known Subclasses:

CoAbstractLayout, CoActionList, CoColumn, CoConnector, CoEmbeddedURLContent, CoEnumerator, CoFrame, CoLabel, CoLayoutRow, CoList, CoPlugin, CoProperty, CoRow, CoSelectList, CoSeparator, com.ptc.core.ca.co.client.primitive.CoSpacer, CoTable, CoTree, CoTreeNode, CoWizard, CoWizardStepList, WebShadow

Deprecated.

@Deprecated
public abstract class CoElement
extends Object
implements CoAddressable, Externalizable

CoElement is a class all conceptual elements extend from. It is configurable and can be drawn. The class provides a default implementation of a drawing algorithm as well as default implementations of initialization and rendering algorithms that delegate actual work to concreate classes.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

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

ADDRESS

Method Summary

boolean	canBePruned(CoEnvData envData) Deprecated. Checks to see if an element can be removed from its parent without the loss of information.
void	default_draw(CoEnvData envData) Deprecated. Implements the default drawing algorithm by calling default_init and default_render methods.
void	default_init(CoEnvData envData) Deprecated. Prepares the element for rendering as follows: Sets a mode of the element Updates the element's model.
void	draw(CoEnvData envData) Deprecated. Method to be called by the parent element or its renderer to draw the element.
CoAddress	getAddress() Deprecated. Gets the object for the association that plays role: address; the address of the element Supported API: true
CoConfigFeature	getConfiguration(CoEnvData envData) Deprecated. Returns the configuration feature describing the element.
CoFrame	getFrame() Deprecated. Returns the frame elemenet this element belongs to.
CoContainer	getParent() Deprecated. Gets the object for the association that plays role: parent; the parent (container) of the element Supported API: true
abstract void	handleDrawError(Throwable t, CoEnvData envData) Deprecated. Implements algorithm to handle errors during the process of drawing the element.
boolean	isBeingRefreshed() Deprecated. Checks to see if an element is in the process of being refreshed.
abstract void	render(CoEnvData envData) Deprecated. Implements rendering algorithm specific to the element's type.
void	setAddress(CoAddress a_Address) Deprecated. Sets the object for the association that plays role: address; the address of the element Supported API: true
void	setParent(CoContainer a_Parent) Deprecated. Sets the object for the association that plays role: parent; the parent (container) of the element Supported API: true

Methods inherited from class java.lang.Object

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

Method Detail

getParent

public CoContainer getParent()

Deprecated.

Gets the object for the association that plays role: parent; the parent (container) of the element

Supported API: true

Returns:

CoContainer

setParent

public void setParent(CoContainer a_Parent)

Deprecated.

Sets the object for the association that plays role: parent; the parent (container) of the element

Supported API: true

Parameters:

a_Parent -

getConfiguration

public CoConfigFeature getConfiguration(CoEnvData envData)
                                 throws WTException

Deprecated.

Returns the configuration feature describing the element.

Supported API: true

Parameters:

envData -

Returns:

CoConfigFeature

Throws:

WTException

draw

public final void draw(CoEnvData envData)
                throws WTException

Deprecated.

Method to be called by the parent element or its renderer to draw the element. The method attempts to locate draw handler to delegate drawing to it. When draw handler is not found, default_draw is called.

Supported API: true

Parameters:

envData -

Throws:

WTException

default_draw

public void default_draw(CoEnvData envData)
                  throws WTException

Deprecated.

Implements the default drawing algorithm by calling default_init and default_render methods.

Supported API: true

Parameters:

envData -

Throws:

WTException

default_init

public void default_init(CoEnvData envData)
                  throws WTException

Deprecated.

Prepares the element for rendering as follows:

• Sets a mode of the element
• Updates the element's model. When a model handler is defined, the processing is delegated to its updateModel| method.
• Updates the element's children when the element implements CoContainer interface.

Supported API: true

Parameters:

envData -

Throws:

WTException

render

public abstract void render(CoEnvData envData)
                     throws WTException

Deprecated.

Implements rendering algorithm specific to the element's type.

Supported API: true

Parameters:

envData -

Throws:

WTException

handleDrawError

public abstract void handleDrawError(Throwable t,
                                     CoEnvData envData)
                              throws WTException

Deprecated.

Implements algorithm to handle errors during the process of drawing the element.

Supported API: true

Parameters:

t -

envData -

Throws:

WTException

getFrame

public CoFrame getFrame()
                 throws WTException

Deprecated.

Returns the frame elemenet this element belongs to.

Supported API: true

Returns:

CoFrame

Throws:

WTException

isBeingRefreshed

public boolean isBeingRefreshed()
                         throws WTException

Deprecated.

Checks to see if an element is in the process of being refreshed. The element is being refereshed when its frame is being refreshed. In DCA Web the frame is being refreshed when the user instructs the browser to refresh the content of its window.

Supported API: true

Returns:

boolean

Throws:

WTException

canBePruned

public boolean canBePruned(CoEnvData envData)
                    throws WTException

Deprecated.

Checks to see if an element can be removed from its parent without the loss of information. An element usually can be pruned when it is completely configuration based like a label or an image.

Supported API: true

Parameters:

envData -

Returns:

boolean

Throws:

WTException

getAddress

public CoAddress getAddress()

Deprecated.

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

Supported API: true

Specified by:

getAddress in interface CoAddressable

Returns:

CoAddress

setAddress

public void setAddress(CoAddress a_Address)

Deprecated.

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

Supported API: true

Specified by:

setAddress in interface CoAddressable

Parameters:

a_Address -