echopoint
Class WizardPane

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.Container
          echopoint.EchoPointComponent
              echopoint.WizardPane

All Implemented Interfaces:

nextapp.echo.event.ActionListener, java.util.EventListener, MouseCursorable, ReflectionSetter, Scrollable, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport

public class WizardPane

extends EchoPointComponent

implements nextapp.echo.event.ActionListener, Scrollable

The WizardPane class provides a component to the Echo Web Framework that allows the user to navigate through a series of logical steps.

Any Component object can be used as the interior of a given pane, however in general you would use a Panel object as the contents, and then fill that Panel with other components.

The WizardPane uses a SingleSelectionModel to represent the set of tab indices and the currently selected index.

If the count is greater than 0, then there will always be a selected index, which by default will be initialized to the first component. If the count is 0, then the selected index will be -1.

WizardPane has an optimisation in place that means that only the currently selected component is given a rendering peer. This ensures that the smallest amount of memory is sxued to render the contents.

The WizardPane will call any WizardNavigationListener's that are registered when the user wants to navigate to another component.

If any listeners are provided, then they can throw a WizardNavigationVetoException to stop the user from navigating way from the current pane. You might do this to implement validation of the pane.

The WizardPane stores the selected index before invoking the WizardNavigationListener interface. If, after completion of the call, the model's selected index is different to the saved index, the selected index will not be decremented or incremented. This allows you to "jump" the WizardPane to a specific index via the WizardNavigationListener processing.

The WizardPane can contain a TitleBar object as its title and footer. Every time the pane changes, the text of the title and footer will change.

The width and height of the WizardPane can be set. This sets the dimensions of the interior of the contents area. If the width is not set, ie it is set to Integer.MAX_VALUE or Integer.MIN_VALUE, then the WizardPane will fill its containing component.

Scrollbars can also be used within the WizardPane.

Author:

Brad Baker

See Also:

for more information., Serialized Form

Nested Class Summary

static class

WizardPane.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	BORDER_COLOR_CHANGED_PROPERTY
static java.lang.String	BORDER_SIZE_CHANGED_PROPERTY
static java.lang.String	BUTTONS_CHANGED_PROPERTY
static java.lang.String	COMPONENT_CHANGED_PROPERTY
static nextapp.echo.Insets	DEFAULT_INSETS
static java.lang.String	ENTRY_CHANGED_PROPERTY
static java.lang.String	FINISH_LAST_ONLY_CHANGED_PROPERTY
static java.lang.String	FOOTER_CHANGED_PROPERTY
static java.lang.String	FOOTERBAR_CHANGED_PROPERTY
static java.lang.String	HEIGHT_CHANGED_PROPERTY
static java.lang.String	INSETS_CHANGED_PROPERTY
static java.lang.String	MODEL_CHANGED_PROPERTY
static java.lang.String	PLACEMENT_CHANGED_PROPERTY
static java.lang.String	RENDERING_CHANGED_PROPERTY
static java.lang.String	SCROLL_BAR_X_CHANGED_PROPERTY This property name is fired when the scolling bar X value changes
static java.lang.String	SCROLL_BAR_Y_CHANGED_PROPERTY This property name is fired when the scolling bar Y value changes
static java.lang.String	SCROLLBAR_POLICY_CHANGED_PROPERTY
static java.lang.String	SELECTED_INDEX_CHANGED_PROPERTY
static java.lang.String	STYLE_BORDER_COLOR A style constant for the Border Color property.
static java.lang.String	STYLE_BORDER_SIZE A style constant for the Border Size property.
static java.lang.String	STYLE_FINISH_ONLY_ON_LAST A style constant for the FinishOnlyOnLast property.
static java.lang.String	STYLE_INSETS A style constant for the Insets property.
static java.lang.String	TITLE_CHANGED_PROPERTY
static java.lang.String	TITLEBAR_CHANGED_PROPERTY
static java.lang.String	WIDTH_CHANGED_PROPERTY

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

Fields inherited from class nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, listenerList, LOCALE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Scrollable

SCROLLBARS_ALWAYS, SCROLLBARS_AUTO, SCROLLBARS_CLIPHIDE, SCROLLBARS_NEVER, STYLE_HEIGHT, STYLE_SCROLL_BAR_POLICY, STYLE_WIDTH, UNDEFINED, undefinedSymbolic

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Constructor Summary

WizardPane()
Constructs a WizardPane with the button placement as EchoConstants.BOTTOM

WizardPane(int buttonPlacement)
Constructs a new WizardPane

Method Summary

void	actionPerformed(nextapp.echo.event.ActionEvent actionEvent) Called when one of the buttons has been pressed and navigation should be done.
void	add(nextapp.echo.Component component) Adds a component to the WizardPane Cover method for insert()
void	add(nextapp.echo.Component component, int index) Adds a component to the WizardPane at the specified index Cover method for insert()
void	add(java.lang.String title, nextapp.echo.Component component) Adds a component to the WizardPane
void	add(java.lang.String title, java.lang.String footer, nextapp.echo.Component component) Adds a component to the WizardPane
void	addChangeListener(nextapp.echo.event.ChangeListener l) Adds a ChangeListener to the WizardPane.
void	addWizardNavigationListener(WizardNavigationListener l) Adds a WizardNavigationListener to the WizardPane.
void	applyStyle(nextapp.echo.Style style) Applies the provided style to the component.
nextapp.echo.Color	getBorderColor()
int	getBorderSize()
nextapp.echo.Button	getCancelButton() Returns the button that acts as the "Cancel" button in the WizardPane.
nextapp.echo.Component	getComponentAt(int index)
int	getCount() Returns the number of entries within the WizardPane.
nextapp.echo.Button	getFinishButton() Returns the button that acts as the "Finish" button in the WizardPane.
TitleBar	getFooter()
java.lang.String	getFooterAt(int index)
int	getHeight() Returns the height of the WizardPane.
nextapp.echo.Insets	getInsets() Returns the insets (margins) of the tabbed pane contents.
SingleSelectionModel	getModel() Returns the model associated with this WizardPane.
nextapp.echo.Button	getNextButton() Returns the button that acts as the "Next" button in the WizardPane.
int	getPlacement()
nextapp.echo.Button	getPreviousButton() Returns the button that acts as the "Previous" button in the WizardPane.
int	getScrollBarPolicy() Returns the ScrollBarPolicy in place This can be one of : SCOLLBARS_NONE SCOLLBARS_ALWAYS SCOLLBARS_AUTO
int	getScrollBarX() Returns the position of the horizontal scroll bar, in pixels offset from the left of the component.
int	getScrollBarY() Returns the position of the vertical scroll bar, in pixels offset from the top the component.
nextapp.echo.Component	getSelectedComponent()
int	getSelectedIndex() Returns the currently selected index or -1 if none is selected
TitleBar	getTitle()
java.lang.String	getTitleAt(int index)
int	getWidth() Returns the width of the WizardPane.
int	indexOfComponent(nextapp.echo.Component c) Returns the index of the given Component or -1 if it is not found
int	indexOfTitle(java.lang.String title) Returns the index with the given title or -1 if it is not found
void	insert(java.lang.String title, nextapp.echo.Component component, int index) Insert a Component at the specified index.
void	insert(java.lang.String title, java.lang.String footer, nextapp.echo.Component component, int index) Insert a Component at the specified index.
boolean	isFinishButtonOnLastOnly() This returns TRUE if the Finish button will be shown on the last wizard page only.
void	remove(nextapp.echo.Component c) Removes a entry from the WizardPane at represented by the Component c
void	remove(int index) Removes a Component entry from the WizardPane at the specified index.
void	removeAll() Removes all entries from the WizardPane.
void	removeChangeListener(nextapp.echo.event.ChangeListener l) Removes a ChangeListener from this component.
void	removeComponentAt(int index) Removes a Component entry from the WizardPane at the specified index.
void	removeWizardNavigationListener(WizardNavigationListener l) Removes a WizardNavigationListener to the WizardPane.
protected void	reRegisterComponents(nextapp.echo.Component oldValue, nextapp.echo.Component newValue) Adds and removes a Component as a child of the WizardPane.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setBorderColor(nextapp.echo.Color newValue) Sets the border color of the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BORDER_COLOR_CHANGED_PROPERTY
void	setBorderSize(int newBorderSize) Sets the border size of the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BORDER_SIZE_CHANGED_PROPERTY
void	setCancelButton(nextapp.echo.Button newButton) Sets the button that acts as the "Cancel" button in the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY
void	setComponentAt(int index, nextapp.echo.Component component) Sets the Component at the specified index This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.COMPONENT_CHANGED_PROPERTY
void	setEnabled(boolean newValue)
void	setFinishButton(nextapp.echo.Button newButton) Sets the button that acts as the "Finish" button in the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY
void	setFinishButtonOnLastOnly(boolean newFinishButtonOnLastOnly) if this is set to TRUE, the Finish button will be shown on the last wizard page only.
void	setFooter(TitleBar newFooterBar) Sets the footer TitleBar of the WizardPane.
void	setFooterAt(int index, java.lang.String footerText) Sets the footer at the specified index This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.FOOTER_CHANGED_PROPERTY
void	setHeight(int newValue) Sets the height of the WizardPane.
void	setInsets(nextapp.echo.Insets newValue) Sets the insets (margins) of the WizardPane
void	setModel(SingleSelectionModel model) Sets the model to be used with this WizardPane .
void	setNextButton(nextapp.echo.Button newButton) Sets the button that acts as the "Next" button in the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY
void	setPlacement(int newPlacement) Sets the placement of buttons within the WizardPane
void	setPreviousButton(nextapp.echo.Button newButton) Sets the button that acts as the "Previous" button in the WizardPane This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY
void	setScrollBarPolicy(int newScrollBarPolicy) This sets the scroll bar policy to use.
void	setScrollBarX(int newValue) Sets the position of the horizontal scroll bar, in pixels offset from the left of the component.
void	setScrollBarY(int newValue) Sets the position of the vertical scroll bar, in pixels offset from the top of the component.
void	setSelectedIndex(int index) Sets the selected tab of the WizardPane.
void	setTitle(TitleBar newTitleBar) Sets the title TitleBar of the WizardPane.
void	setTitleAt(int index, java.lang.String title) Sets the title at the specified index This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.TITLE_CHANGED_PROPERTY
void	setWidth(int newValue) Sets the width of the WizardPane.
void	validate()

Methods inherited from class echopoint.EchoPointComponent

getMouseCursor, getMouseCursorURI, getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, setMouseCursor, setMouseCursorURI, setToolTipText

Methods inherited from class nextapp.echo.Component

addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getLocale, getParent, indexOf, init, isAncestorOf, isEnabled, isRegistered, isShowing, isVisible, removeHierarchyListener, removePropertyChangeListener, setBackground, setFont, setForeground, setIdentifier, setLocale, setVisible, update

Methods inherited from class java.lang.Object

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

Field Detail

BORDER_COLOR_CHANGED_PROPERTY

public static final java.lang.String BORDER_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

BORDER_SIZE_CHANGED_PROPERTY

public static final java.lang.String BORDER_SIZE_CHANGED_PROPERTY

See Also:

Constant Field Values

BUTTONS_CHANGED_PROPERTY

public static final java.lang.String BUTTONS_CHANGED_PROPERTY

See Also:

Constant Field Values

COMPONENT_CHANGED_PROPERTY

public static final java.lang.String COMPONENT_CHANGED_PROPERTY

See Also:

Constant Field Values

DEFAULT_INSETS

public static final nextapp.echo.Insets DEFAULT_INSETS

ENTRY_CHANGED_PROPERTY

public static final java.lang.String ENTRY_CHANGED_PROPERTY

See Also:

Constant Field Values

FINISH_LAST_ONLY_CHANGED_PROPERTY

public static final java.lang.String FINISH_LAST_ONLY_CHANGED_PROPERTY

See Also:

Constant Field Values

FOOTER_CHANGED_PROPERTY

public static final java.lang.String FOOTER_CHANGED_PROPERTY

See Also:

Constant Field Values

FOOTERBAR_CHANGED_PROPERTY

public static final java.lang.String FOOTERBAR_CHANGED_PROPERTY

See Also:

Constant Field Values

HEIGHT_CHANGED_PROPERTY

public static final java.lang.String HEIGHT_CHANGED_PROPERTY

See Also:

Constant Field Values

INSETS_CHANGED_PROPERTY

public static final java.lang.String INSETS_CHANGED_PROPERTY

See Also:

Constant Field Values

MODEL_CHANGED_PROPERTY

public static final java.lang.String MODEL_CHANGED_PROPERTY

See Also:

Constant Field Values

PLACEMENT_CHANGED_PROPERTY

public static final java.lang.String PLACEMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

RENDERING_CHANGED_PROPERTY

public static final java.lang.String RENDERING_CHANGED_PROPERTY

See Also:

Constant Field Values

SCROLL_BAR_X_CHANGED_PROPERTY

public static final java.lang.String SCROLL_BAR_X_CHANGED_PROPERTY

This property name is fired when the scolling bar X value changes

See Also:

Constant Field Values

SCROLL_BAR_Y_CHANGED_PROPERTY

public static final java.lang.String SCROLL_BAR_Y_CHANGED_PROPERTY

This property name is fired when the scolling bar Y value changes

See Also:

Constant Field Values

SCROLLBAR_POLICY_CHANGED_PROPERTY

public static final java.lang.String SCROLLBAR_POLICY_CHANGED_PROPERTY

See Also:

Constant Field Values

SELECTED_INDEX_CHANGED_PROPERTY

public static final java.lang.String SELECTED_INDEX_CHANGED_PROPERTY

See Also:

Constant Field Values

STYLE_BORDER_COLOR

public static final java.lang.String STYLE_BORDER_COLOR

A style constant for the Border Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_BORDER_SIZE

public static final java.lang.String STYLE_BORDER_SIZE

A style constant for the Border Size property. Values of this key must be of type Integer.

See Also:

Constant Field Values

STYLE_FINISH_ONLY_ON_LAST

public static final java.lang.String STYLE_FINISH_ONLY_ON_LAST

A style constant for the FinishOnlyOnLast property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_INSETS

public static final java.lang.String STYLE_INSETS

A style constant for the Insets property. Values of this key must be of type nextapp.echo.Insets.

See Also:

Constant Field Values

TITLE_CHANGED_PROPERTY

public static final java.lang.String TITLE_CHANGED_PROPERTY

See Also:

Constant Field Values

TITLEBAR_CHANGED_PROPERTY

public static final java.lang.String TITLEBAR_CHANGED_PROPERTY

See Also:

Constant Field Values

WIDTH_CHANGED_PROPERTY

public static final java.lang.String WIDTH_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

WizardPane

public WizardPane()

Constructs a WizardPane with the button placement as EchoConstants.BOTTOM

WizardPane

public WizardPane(int buttonPlacement)

Constructs a new WizardPane

Parameters:

buttonPlacement - the button placement of the WizardPane, can be one of the following values.

• EchoConstants.BOTTOM (the default)
• EchoConstants.TOP

Method Detail

actionPerformed

public void actionPerformed(nextapp.echo.event.ActionEvent actionEvent)

Called when one of the buttons has been pressed and navigation should be done. Each of the WizardNavigationListners will be called to determine if navigation should take place.

Specified by:

actionPerformed in interface nextapp.echo.event.ActionListener

add

public void add(nextapp.echo.Component component)

Adds a component to the WizardPane

Cover method for insert()

Parameters:

component -

add

public void add(nextapp.echo.Component component,
                int index)

Adds a component to the WizardPane at the specified index

Cover method for insert()

Parameters:

component -

add

public void add(java.lang.String title,
                nextapp.echo.Component component)

Adds a component to the WizardPane

add

public void add(java.lang.String title,
                java.lang.String footer,
                nextapp.echo.Component component)

Adds a component to the WizardPane

addChangeListener

public void addChangeListener(nextapp.echo.event.ChangeListener l)

Adds a ChangeListener to the WizardPane.

Parameters:

l - The ChangeListener to be added.

addWizardNavigationListener

public void addWizardNavigationListener(WizardNavigationListener l)

Adds a WizardNavigationListener to the WizardPane.

Parameters:

l - The ChangeListener to be added.

applyStyle

public void applyStyle(nextapp.echo.Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

Specified by:

applyStyle in interface Scrollable

Overrides:

applyStyle in class EchoPointComponent

See Also:

Component.applyStyle(nextapp.echo.Style)

getBorderColor

public nextapp.echo.Color getBorderColor()

Returns:

The Color of the WizardPane's border.

getBorderSize

public int getBorderSize()

Returns:

The size of the WizardPane's border.

getCancelButton

public nextapp.echo.Button getCancelButton()

Returns the button that acts as the "Cancel" button in the WizardPane.

getComponentAt

public nextapp.echo.Component getComponentAt(int index)

Returns:

The Component at the specified index.

getCount

public int getCount()

Returns the number of entries within the WizardPane.

getFinishButton

public nextapp.echo.Button getFinishButton()

Returns the button that acts as the "Finish" button in the WizardPane.

getFooter

public TitleBar getFooter()

Returns:

The footer TitleBar of the WizardPane

getFooterAt

public java.lang.String getFooterAt(int index)

Returns:

The footer of the Component at the specified index.

getHeight

public int getHeight()

Returns the height of the WizardPane. If this value is -1, then no height will be used.

Specified by:

getHeight in interface Scrollable

getInsets

public nextapp.echo.Insets getInsets()

Returns the insets (margins) of the tabbed pane contents.

Returns:

The insets of the tabbed pane.

getModel

public SingleSelectionModel getModel()

Returns the model associated with this WizardPane.

getNextButton

public nextapp.echo.Button getNextButton()

Returns the button that acts as the "Next" button in the WizardPane.

getPlacement

public int getPlacement()

Returns:

The placement of buttons wihtin the WizardPane

getPreviousButton

public nextapp.echo.Button getPreviousButton()

Returns the button that acts as the "Previous" button in the WizardPane.

getScrollBarPolicy

public int getScrollBarPolicy()

Returns the ScrollBarPolicy in place This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

Specified by:

getScrollBarPolicy in interface Scrollable

getScrollBarX

public int getScrollBarX()

Returns the position of the horizontal scroll bar, in pixels offset from the left of the component.

Specified by:

getScrollBarX in interface Scrollable

Returns:

The position of the horizontal scroll bar.

getScrollBarY

public int getScrollBarY()

Returns the position of the vertical scroll bar, in pixels offset from the top the component.

Specified by:

getScrollBarY in interface Scrollable

Returns:

The position of the vertical scroll bar.

getSelectedComponent

public nextapp.echo.Component getSelectedComponent()

Returns:

the Component at the currently selected index or null if none is currently selected.

getSelectedIndex

public int getSelectedIndex()

Returns the currently selected index or -1 if none is selected

getTitle

public TitleBar getTitle()

Returns:

The title TitleBar of the WizardPane

getTitleAt

public java.lang.String getTitleAt(int index)

Returns:

The title of the Component at the specified index.

getWidth

public int getWidth()

Returns the width of the WizardPane. If this value is -1, then no width will be used.

Specified by:

getWidth in interface Scrollable

indexOfComponent

public int indexOfComponent(nextapp.echo.Component c)

Returns the index of the given Component or -1 if it is not found

indexOfTitle

public int indexOfTitle(java.lang.String title)

Returns the index with the given title or -1 if it is not found

insert

public void insert(java.lang.String title,
                   nextapp.echo.Component component,
                   int index)

Insert a Component at the specified index.

insert

public void insert(java.lang.String title,
                   java.lang.String footer,
                   nextapp.echo.Component component,
                   int index)

Insert a Component at the specified index.

isFinishButtonOnLastOnly

public boolean isFinishButtonOnLastOnly()

This returns TRUE if the Finish button will be shown on the last wizard page only. If this is FALSE, then the Finsih button will show on all wizard pages.

Returns:

boolean

remove

public void remove(nextapp.echo.Component c)

Removes a entry from the WizardPane at represented by the Component c

remove

public void remove(int index)

Removes a Component entry from the WizardPane at the specified index.

removeAll

public void removeAll()

Removes all entries from the WizardPane.

removeChangeListener

public void removeChangeListener(nextapp.echo.event.ChangeListener l)

Removes a ChangeListener from this component.

Parameters:

l - the ChangeListener to remove

removeComponentAt

public void removeComponentAt(int index)

Removes a Component entry from the WizardPane at the specified index.

removeWizardNavigationListener

public void removeWizardNavigationListener(WizardNavigationListener l)

Removes a WizardNavigationListener to the WizardPane.

Parameters:

l - The ChangeListener to be added.

reRegisterComponents

protected void reRegisterComponents(nextapp.echo.Component oldValue,
                                    nextapp.echo.Component newValue)

Adds and removes a Component as a child of the WizardPane.

Parameters:

oldValue - - the old component to remove - can be null

newValue - - the new component to add - can be null

setBorderColor

public void setBorderColor(nextapp.echo.Color newValue)

Sets the border color of the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BORDER_COLOR_CHANGED_PROPERTY

setBorderSize

public void setBorderSize(int newBorderSize)

Sets the border size of the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BORDER_SIZE_CHANGED_PROPERTY

setCancelButton

public void setCancelButton(nextapp.echo.Button newButton)

Sets the button that acts as the "Cancel" button in the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY

setComponentAt

public void setComponentAt(int index,
                           nextapp.echo.Component component)

Sets the Component at the specified index
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.COMPONENT_CHANGED_PROPERTY

setEnabled

public void setEnabled(boolean newValue)

See Also:

Component.setEnabled(boolean)

setFinishButton

public void setFinishButton(nextapp.echo.Button newButton)

Sets the button that acts as the "Finish" button in the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY

setFinishButtonOnLastOnly

public void setFinishButtonOnLastOnly(boolean newFinishButtonOnLastOnly)

if this is set to TRUE, the Finish button will be shown on the last wizard page only. If this is FALSE, then the Finsih button will show on all wizard pages.

Parameters:

newFinishButtonOnLastOnly - boolean

setFooter

public void setFooter(TitleBar newFooterBar)

Sets the footer TitleBar of the WizardPane.
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.FOOTERBAR_CHANGED_PROPERTY

setFooterAt

public void setFooterAt(int index,
                        java.lang.String footerText)

Sets the footer at the specified index
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.FOOTER_CHANGED_PROPERTY

setHeight

public void setHeight(int newValue)

Sets the height of the WizardPane. If this value is -1, then no height will be used.

Note that this is the height of the contents of the WizardPane not the outside of the Wizard Pane. This allows scrolling within the contents of the wizard pane.

This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.HEIGHT_CHANGED_PROPERTY

Specified by:

setHeight in interface Scrollable

setInsets

public void setInsets(nextapp.echo.Insets newValue)

Sets the insets (margins) of the WizardPane

Parameters:

newValue - An insets object that specifies the size of each margin of this WizardPane

setModel

public void setModel(SingleSelectionModel model)

Sets the model to be used with this WizardPane .

setNextButton

public void setNextButton(nextapp.echo.Button newButton)

Sets the button that acts as the "Next" button in the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY

setPlacement

public void setPlacement(int newPlacement)

Sets the placement of buttons within the WizardPane

Parameters:

newPlacement - the placement of the buttons can be one of the following values.

• EchoConstants.BOTTOM (the default)
• EchoConstants.TOP

setPreviousButton

public void setPreviousButton(nextapp.echo.Button newButton)

Sets the button that acts as the "Previous" button in the WizardPane
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.BUTTONS_CHANGED_PROPERTY

setScrollBarPolicy

public void setScrollBarPolicy(int newScrollBarPolicy)

This sets the scroll bar policy to use. This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

Specified by:

setScrollBarPolicy in interface Scrollable

setScrollBarX

public void setScrollBarX(int newValue)

Sets the position of the horizontal scroll bar, in pixels offset from the left of the component.

Specified by:

setScrollBarX in interface Scrollable

Parameters:

newValue - The new position of the horizontal scroll bar, in pixels.

setScrollBarY

public void setScrollBarY(int newValue)

Sets the position of the vertical scroll bar, in pixels offset from the top of the component.

Specified by:

setScrollBarY in interface Scrollable

Parameters:

newValue - The new position of the vertical scroll bar, in pixels.

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected tab of the WizardPane.

setTitle

public void setTitle(TitleBar newTitleBar)

Sets the title TitleBar of the WizardPane.
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.TITLEBAR_CHANGED_PROPERTY

setTitleAt

public void setTitleAt(int index,
                       java.lang.String title)

Sets the title at the specified index
This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.TITLE_CHANGED_PROPERTY

setWidth

public void setWidth(int newValue)

Sets the width of the WizardPane. If this value is -1, then no width will be used.

Note that this is the height of the contents of the WizardPane not the outside of the Wizard Pane. This allows scrolling within the contents of the wizard pane.

This methods fires a PropertyChangeEvent with a getPropertyName() value of WizardPane.WIDTH_CHANGED_PROPERTY

Specified by:

setWidth in interface Scrollable

validate

public void validate()

Overrides:

validate in class EchoPointComponent

See Also:

Component.validate()

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)