com.ptc.core.ca.co.client.wizard
Class CoWizard

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

All Implemented Interfaces:

CoActionListHolder, CoAddressable, CoInstanceChangeListener, CoCleanable, CoContainer, CoFacePlateHolder, CoInstanceHolder, com.ptc.core.ca.co.client.element.CoModeDriven, CoModelDriven, CoFrameManaged, com.ptc.core.ca.co.client.layout.CoLayoutManaged, CoListManaged, Externalizable, Serializable

Direct Known Subclasses:

WebWizard

Deprecated.

@Deprecated
public abstract class CoWizard
extends CoElement
implements CoFrameManaged, CoInstanceHolder, CoContainer, CoActionListHolder, com.ptc.core.ca.co.client.element.CoModeDriven, CoFacePlateHolder, com.ptc.core.ca.co.client.layout.CoLayoutManaged, CoListManaged, Externalizable

This class implements a conceptual wizard element. The wizard element is capable of managing wizard steps and wizard actions like ok, apply, next, previous, and cancel.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

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

ADDRESS

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

DIRTY

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

MODEL

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

CHILDREN

Method Summary

CoElement	createDynamicSubElement(String typeId, CoEnvData envData) Deprecated. Creates a dynamic sub-element.
CoElement	createStaticSubElement(CoConfigFeature subElementConfiguration, CoEnvData envData) Deprecated. Creates a static sub-element.
Map	getChildren() Deprecated. Gets the value of the attribute: children; the map of child elements.
CoInstance	getInstance(CoEnvData envData) Deprecated. Returns the I*E element maintained by the this element wrapped into CoInstance object Supported API: true
CoModel	getModel() Deprecated. Gets the object for the association that plays role: model; the model of the element Supported API: true
boolean	isDirty() Deprecated. Gets the value of the attribute: dirty; the flag indicating whether the element is out of date.
CoModel	newModel() Deprecated. Returns newly created model of CoDefaultWizardModel class.
void	onChange(CoEnvData envData) Deprecated. Notifies CoElement that its data is obsolete.
void	pruneChildren(CoEnvData envData) Deprecated. Removes sub-elements that do not have to be maintained and can easily be restored during new drawing.
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	setInstance(CoInstance instance, CoEnvData envData) Deprecated. Sets the I*E element wrapped into CoInstance object to be maintained by the this element.
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	updateChildren(CoEnvData envData) Deprecated. Updates sub-elements.
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, isBeingRefreshed, 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.address.CoAddressable

getAddress, setAddress

Method Detail

getInstance

public CoInstance getInstance(CoEnvData envData)
                       throws WTException

Deprecated.

Returns the I*E element maintained by the this element wrapped into CoInstance object

Supported API: true

Specified by:

getInstance in interface CoInstanceHolder

Parameters:

envData -

Returns:

CoInstance

Throws:

WTException

setInstance

public void setInstance(CoInstance instance,
                        CoEnvData envData)
                 throws WTException

Deprecated.

Sets the I*E element wrapped into CoInstance object to be maintained by the this element.

Supported API: true

Specified by:

setInstance in interface CoInstanceHolder

Parameters:

instance -

envData -

Throws:

WTException

onChange

public void onChange(CoEnvData envData)
              throws WTException

Deprecated.

Notifies CoElement that its data is obsolete.

Supported API: true

Specified by:

onChange in interface CoInstanceChangeListener

Parameters:

envData -

Throws:

WTException

newModel

public CoModel newModel()

Deprecated.

Returns newly created model of CoDefaultWizardModel class.

Supported API: true

Specified by:

newModel in interface CoModelDriven

Returns:

CoModel

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

updateChildren

public void updateChildren(CoEnvData envData)
                    throws WTException

Deprecated.

Updates sub-elements. After the execution of the method the element's model and children map should contain sub-elements according to the configuration specification and data from the data aquisition layer.

Supported API: true

Specified by:

updateChildren in interface CoContainer

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 dynamic sub-element. Sub-element is considered to be dynamic when its existence is defined by configuration specification and data from the data aqusition layer.

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

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 -

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 -

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 -