ariba.ui.wizard.core
Class WizardFrame

java.lang.Object
  ariba.ui.wizard.core.WizardFrame

All Implemented Interfaces:

WizardActionTarget

public final class WizardFrame
extends java.lang.Object
implements WizardActionTarget

Field Summary

static java.lang.String

ActionParamKey

Constructor Summary

WizardFrame(WizardFrameMeta frameMeta, WizardStep step, Wizard wizard)

WizardFrame(Wizard wizard, java.lang.String name, java.lang.String label, java.lang.String source)
Constructor

WizardFrame(Wizard wizard, java.lang.String name, java.lang.String label, java.lang.String source, java.lang.String formEncoding, WizardFrameDelegate delegate, java.lang.String[] actionNames)
Constructor

Method Summary

WizardAction[]	getActions() Returns the list of actions including both built-in and custom actions
java.lang.Object	getAttribute(java.lang.Object key) Returns the value for the attribute with the given key.
WizardFrame	getBackFrame() Returns the frame set the previously visited frame.
java.lang.String	getDefaultAction() Returns the default action name
java.lang.String	getDefaultDelegateName() Returns the class name of the default frame delegate as specified in the xml
WizardFrameDelegate	getDelegate() Returns the wizard frame delegate instance.
java.lang.String	getFormEncoding() Returns the form encoding type
java.lang.String	getLabel() Returns the label
java.lang.String	getName() Returns the frame name
WizardFrame	getOriginatingFrame() Returns the frame that is responsible for taking form values and handling actions originated from this target.
java.lang.String	getSource() Returns the resource of the frame
WizardStep	getStep() Returns the enclosing step for this frame.
boolean	getSubmitFormDefault()
java.lang.String	getType()
Wizard	getWizard() Returns the wizard
boolean	isDialogFrame() Returns true if the this is a dialog frame.
boolean	isValid()
boolean	isVisible() Returns true if this frame is visible.
void	removeAttribute(java.lang.Object key) Removes a particular attribute from this frame
void	setActions(WizardAction[] actions) here for demoshell
void	setAttribute(java.lang.Object key, java.lang.Object value) sets an user-defined attribute on this frame
void	setDelegate(WizardFrameDelegate delegate)
void	setLabel(java.lang.String localizedLabel) overrides the default value for the wizard frame label
void	setShowErrors(boolean showErrors)
void	setStep(WizardStep step)
void	setValid(boolean valid) Allows the WizardFrameDelegate to validate the values associated with the current frame.
void	setVisible(boolean visible) Changes the visibility of this frame.
boolean	shouldShowErrors()
boolean	terminatesWizard() Returns true if this ation target should terminate the current wizard.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ActionParamKey

public static final java.lang.String ActionParamKey

See Also:

Constant Field Values

Constructor Detail

WizardFrame

public WizardFrame(Wizard wizard,
                   java.lang.String name,
                   java.lang.String label,
                   java.lang.String source)

Constructor

WizardFrame

public WizardFrame(Wizard wizard,
                   java.lang.String name,
                   java.lang.String label,
                   java.lang.String source,
                   java.lang.String formEncoding,
                   WizardFrameDelegate delegate,
                   java.lang.String[] actionNames)

Constructor

WizardFrame

public WizardFrame(WizardFrameMeta frameMeta,
                   WizardStep step,
                   Wizard wizard)

Method Detail

setActions

public void setActions(WizardAction[] actions)

here for demoshell

getName

public java.lang.String getName()

Returns the frame name

getWizard

public Wizard getWizard()

Returns the wizard

getDelegate

public WizardFrameDelegate getDelegate()

Returns the wizard frame delegate instance. It could either be returned by WizardDelegate.getFrameDelegate() or instantiated from the delegate class name specified in the frame xml if the WizardDelegate returns null.

setDelegate

public void setDelegate(WizardFrameDelegate delegate)

getDefaultDelegateName

public java.lang.String getDefaultDelegateName()

Returns the class name of the default frame delegate as specified in the xml

getLabel

public java.lang.String getLabel()

Returns the label

setLabel

public void setLabel(java.lang.String localizedLabel)

overrides the default value for the wizard frame label

Parameters:

localizedLabel - localized string used as labe for wizard frame

getDefaultAction

public java.lang.String getDefaultAction()

Returns the default action name

getFormEncoding

public java.lang.String getFormEncoding()

Returns the form encoding type

getSubmitFormDefault

public boolean getSubmitFormDefault()

getType

public java.lang.String getType()

getSource

public java.lang.String getSource()

Returns the resource of the frame

getActions

public WizardAction[] getActions()

Returns the list of actions including both built-in and custom actions

getStep

public WizardStep getStep()

Returns the enclosing step for this frame. Returns null for dialog frames.

setStep

public void setStep(WizardStep step)

isDialogFrame

public boolean isDialogFrame()

Returns true if the this is a dialog frame. Also see getStep()

setAttribute

public void setAttribute(java.lang.Object key,
                         java.lang.Object value)

sets an user-defined attribute on this frame

getAttribute

public java.lang.Object getAttribute(java.lang.Object key)

Returns the value for the attribute with the given key. If the attribute had not been set, it would return null.

removeAttribute

public void removeAttribute(java.lang.Object key)

Removes a particular attribute from this frame

isVisible

public boolean isVisible()

Returns true if this frame is visible. By default, all frames are visible. The visibility can be changed by wizard frame delegate, usually inside the targetForAction() method. See also setVisible()

setVisible

public void setVisible(boolean visible)

Changes the visibility of this frame. See also isVisible()

isValid

public boolean isValid()

setValid

public void setValid(boolean valid)

Allows the WizardFrameDelegate to validate the values associated with the current frame. Return true if all frame values are valid according to the application's business logic, or false if there are invalid values. It is left up to the application to manage the display of these invalid values within the frame content.

getBackFrame

public WizardFrame getBackFrame()

Returns the frame set the previously visited frame. This is usefu for dialog frames

shouldShowErrors

public boolean shouldShowErrors()

setShowErrors

public void setShowErrors(boolean showErrors)

getOriginatingFrame

public WizardFrame getOriginatingFrame()

Description copied from interface: WizardActionTarget

Returns the frame that is responsible for taking form values and handling actions originated from this target.

Specified by:

getOriginatingFrame in interface WizardActionTarget

terminatesWizard

public boolean terminatesWizard()

Description copied from interface: WizardActionTarget

Returns true if this ation target should terminate the current wizard.

Specified by:

terminatesWizard in interface WizardActionTarget