com.ptc.core.ca.co.client.wizard
Interface CoWizardModel

All Superinterfaces:

CoActionListHolderModel, CoFacePlateHolderModel, CoInstanceHolderModel, CoModel

All Known Implementing Classes:

CoDefaultWizardModel

Deprecated.

@Deprecated
public interface CoWizardModel
extends CoInstanceHolderModel, CoActionListHolderModel, CoFacePlateHolderModel

The interface the model of the wizard element implements.

Supported API: true

Extendable: false

Field Summary

static String	CURRENT_STEP_INDEX Deprecated. Label for the attribute; the index of a current wizard step.
static String	HEADER_LAYOUT Deprecated. Label for the attribute; the header layout.
static String	PREVIOUS_STEP_INDEX Deprecated. Label for the attribute; the index of the step that was current before the current step.
static String	STEP_ACTIONS Deprecated. Label for the attribute; the action list containing actions to move to a particular step.
static String	STEP_LIST Deprecated. Label for the attribute; the step list sub-element of the wizard Supported API: true
static String	WIZARD_ACTIONS Deprecated. Label for the attribute; the list of wizard actions like ok, apply, next, previous, and cancel.

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

INSTANCE

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

ELEMENT

Fields inherited from interface com.ptc.core.ca.co.client.action.CoActionListHolderModel

ACTION_LIST

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

ELEMENT

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

FACE_PLATE_TYPE, IMAGE, LABEL, TOOL_TIP

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

ELEMENT

Method Summary

int	getCurrentStepIndex() Deprecated. Gets the value of the attribute: CURRENT_STEP_INDEX.
CoSimpleLayout	getHeaderLayout() Deprecated. Gets the value of the attribute: HEADER_LAYOUT.
int	getPreviousStepIndex() Deprecated. Gets the value of the attribute: PREVIOUS_STEP_INDEX.
CoActionList	getStepActions() Deprecated. Gets the value of the attribute: STEP_ACTIONS.
CoWizardStepList	getStepList() Deprecated. Gets the value of the attribute: STEP_LIST.
CoActionList	getWizardActions() Deprecated. Gets the value of the attribute: WIZARD_ACTIONS.
void	setCurrentStepIndex(int a_CurrentStepIndex) Deprecated. Sets the value of the attribute: CURRENT_STEP_INDEX.
void	setHeaderLayout(CoSimpleLayout a_HeaderLayout) Deprecated. Sets the value of the attribute: HEADER_LAYOUT.
void	setPreviousStepIndex(int a_PreviousStepIndex) Deprecated. Sets the value of the attribute: PREVIOUS_STEP_INDEX.
void	setStepActions(CoActionList a_StepActions) Deprecated. Sets the value of the attribute: STEP_ACTIONS.
void	setStepList(CoWizardStepList a_StepList) Deprecated. Sets the value of the attribute: STEP_LIST.
void	setWizardActions(CoActionList a_WizardActions) Deprecated. Sets the value of the attribute: WIZARD_ACTIONS.

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

getInstance, setInstance

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

getElement, init, setElement, update

Methods inherited from interface com.ptc.core.ca.co.client.action.CoActionListHolderModel

getActionList, setActionList

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

getElement, init, setElement, update

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

getFacePlateType, getImage, getLabel, getToolTip, setFacePlateType, setImage, setLabel, setToolTip

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

getElement, init, setElement, update

Field Detail

HEADER_LAYOUT

static final String HEADER_LAYOUT

Deprecated.

Label for the attribute; the header layout. When a header layout is specified, a faceplate is ignored.

Supported API: true

See Also:

Constant Field Values

STEP_LIST

static final String STEP_LIST

Deprecated.

Label for the attribute; the step list sub-element of the wizard

Supported API: true

See Also:

Constant Field Values

STEP_ACTIONS

static final String STEP_ACTIONS

Deprecated.

Label for the attribute; the action list containing actions to move to a particular step. The user can use step action to move to a step that is not necessary next or previous.

Supported API: true

See Also:

Constant Field Values

WIZARD_ACTIONS

static final String WIZARD_ACTIONS

Deprecated.

Label for the attribute; the list of wizard actions like ok, apply, next, previous, and cancel.

Supported API: true

See Also:

Constant Field Values

CURRENT_STEP_INDEX

static final String CURRENT_STEP_INDEX

Deprecated.

Label for the attribute; the index of a current wizard step. The wizard always presents a single element from the step list with this index.

Supported API: true

See Also:

Constant Field Values

PREVIOUS_STEP_INDEX

static final String PREVIOUS_STEP_INDEX

Deprecated.

Label for the attribute; the index of the step that was current before the current step.

Supported API: true

See Also:

Constant Field Values

Method Detail

getHeaderLayout

CoSimpleLayout getHeaderLayout()

Deprecated.

Gets the value of the attribute: HEADER_LAYOUT. the header layout. When a header layout is specified, a faceplate is ignored.

Supported API: true

Returns:

CoSimpleLayout

setHeaderLayout

void setHeaderLayout(CoSimpleLayout a_HeaderLayout)

Deprecated.

Sets the value of the attribute: HEADER_LAYOUT. the header layout. When a header layout is specified, a faceplate is ignored.

Supported API: true

Parameters:

a_HeaderLayout -

getStepList

CoWizardStepList getStepList()

Deprecated.

Gets the value of the attribute: STEP_LIST. the step list sub-element of the wizard

Supported API: true

Returns:

CoWizardStepList

setStepList

void setStepList(CoWizardStepList a_StepList)

Deprecated.

Sets the value of the attribute: STEP_LIST. the step list sub-element of the wizard

Supported API: true

Parameters:

a_StepList -

getStepActions

CoActionList getStepActions()

Deprecated.

Gets the value of the attribute: STEP_ACTIONS. the action list containing actions to move to a particular step. The user can use step action to move to a step that is not necessary next or previous.

Supported API: true

Returns:

CoActionList

setStepActions

void setStepActions(CoActionList a_StepActions)

Deprecated.

Sets the value of the attribute: STEP_ACTIONS. the action list containing actions to move to a particular step. The user can use step action to move to a step that is not necessary next or previous.

Supported API: true

Parameters:

a_StepActions -

getWizardActions

CoActionList getWizardActions()

Deprecated.

Gets the value of the attribute: WIZARD_ACTIONS. the list of wizard actions like ok, apply, next, previous, and cancel.

Supported API: true

Returns:

CoActionList

setWizardActions

void setWizardActions(CoActionList a_WizardActions)

Deprecated.

Sets the value of the attribute: WIZARD_ACTIONS. the list of wizard actions like ok, apply, next, previous, and cancel.

Supported API: true

Parameters:

a_WizardActions -

getCurrentStepIndex

int getCurrentStepIndex()

Deprecated.

Gets the value of the attribute: CURRENT_STEP_INDEX. the index of a current wizard step. The wizard always presents a single element from the step list with this index.

Supported API: true

Returns:

int

setCurrentStepIndex

void setCurrentStepIndex(int a_CurrentStepIndex)

Deprecated.

Sets the value of the attribute: CURRENT_STEP_INDEX. the index of a current wizard step. The wizard always presents a single element from the step list with this index.

Supported API: true

Parameters:

a_CurrentStepIndex -

getPreviousStepIndex

int getPreviousStepIndex()

Deprecated.

Gets the value of the attribute: PREVIOUS_STEP_INDEX. the index of the step that was current before the current step.

Supported API: true

Returns:

int

setPreviousStepIndex

void setPreviousStepIndex(int a_PreviousStepIndex)

Deprecated.

Sets the value of the attribute: PREVIOUS_STEP_INDEX. the index of the step that was current before the current step.

Supported API: true

Parameters:

a_PreviousStepIndex -