Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> [ echopoint overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of echopoint.WizardPane JAVADOC | Sourc code of echopoint.WizardPane SOURCE | Download echopoint.WizardPane DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

echopoint
Class WizardPane  view WizardPane download WizardPane.java

java.lang.Object
  extended bynextapp.echo.Component
      extended bynextapp.echo.Container
          extended byechopoint.EchoPointComponent
              extended byechopoint.WizardPane
All Implemented Interfaces:
nextapp.echo.event.ActionListener, java.util.EventListener, echopoint.util.reflect.ReflectionSetter, echopoint.positionable.Scrollable, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport
public class WizardPane
extends EchoPointComponent
implements nextapp.echo.event.ActionListener, echopoint.positionable.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.

Nested Class Summary
static class WizardPane.NestedStyleInfo
          Nested public static StyleInfo class.
private  class WizardPane.WizardEntry
           
 
Field Summary
static java.lang.String BORDER_COLOR_CHANGED_PROPERTY
           
static java.lang.String BORDER_SIZE_CHANGED_PROPERTY
           
private  nextapp.echo.Color borderColor
           
private  int borderSize
           
static java.lang.String BUTTONS_CHANGED_PROPERTY
           
private  nextapp.echo.Button cancelButton
           
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
           
private  nextapp.echo.Button finishButton
           
private  boolean finishButtonOnLastOnly
           
static java.lang.String FOOTER_CHANGED_PROPERTY
           
private  TitleBar footerBar
           
static java.lang.String FOOTERBAR_CHANGED_PROPERTY
           
private  int height
           
static java.lang.String HEIGHT_CHANGED_PROPERTY
           
private  nextapp.echo.Insets insets
           
static java.lang.String INSETS_CHANGED_PROPERTY
           
private  DevNull invisibleContainer
           
private  echopoint.model.SingleSelectionModel model
           
static java.lang.String MODEL_CHANGED_PROPERTY
           
private  nextapp.echo.Button nextButton
           
private  int placement
           
static java.lang.String PLACEMENT_CHANGED_PROPERTY
           
private  nextapp.echo.Button prevButton
           
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
           
private  int scrollBarPolicy
           
private  int scrollBarX
           
private  int scrollBarY
           
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
           
private  TitleBar titleBar
           
static java.lang.String TITLEBAR_CHANGED_PROPERTY
           
private  nextapp.echo.Container visibleContainer
           
private  int width
           
static java.lang.String WIDTH_CHANGED_PROPERTY
           
private  java.util.ArrayList wizardList
           
 
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, TAB_INDEX_CHANGED_PROPERTY, 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
 
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
 void add(nextapp.echo.Component component, int index)
          Adds a component to the WizardPane at the specified index
 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(echopoint.wizard.WizardNavigationListener l)
          Adds a WizardNavigationListener to the WizardPane.
 void applyStyle(nextapp.echo.Style style)
          Applies the provided style to the component.
private  void checkAndSetSelectedIndex(int savedSelectedIndex, int toIndex)
          This method will check that the currently selected index of the the WizardPane is still the same as a saved value.
private  void fireOnNavigation(int type, nextapp.echo.Component fromComponent, nextapp.echo.Component toComponent, int fromIndex, int toIndex)
          Called to notify all WizardNavigationListener's of a navigation event.
 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.
 echopoint.model.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.
private  WizardPane.WizardEntry getWizardEntryAt(int index)
          Returns the tab entry at a specified index.
 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.
private  void reArrangeVisibleComponents(nextapp.echo.Component removedComponent)
          Called to rearrange the components inside the WizardPane It moves the currently selected component into the visible container and the rest into the invisible bucket.
 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(echopoint.wizard.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)
          Sets whether the component is enabled.
 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(echopoint.model.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()
          Validates this component.
 
Methods inherited from class echopoint.EchoPointComponent
getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, 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, getTabIndex, indexOf, init, isAncestorOf, isEnabled, isFocused, isRegistered, isShowing, isVisible, removeHierarchyListener, removePropertyChangeListener, setBackground, setFocused, setFont, setForeground, setIdentifier, setLocale, setTabIndex, 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

borderColor

private nextapp.echo.Color borderColor

borderSize

private int borderSize

finishButtonOnLastOnly

private boolean finishButtonOnLastOnly

footerBar

private TitleBar footerBar

insets

private nextapp.echo.Insets insets

width

private int width

scrollBarX

private int scrollBarX

scrollBarY

private int scrollBarY

height

private int height

invisibleContainer

private DevNull invisibleContainer

visibleContainer

private nextapp.echo.Container visibleContainer

model

private echopoint.model.SingleSelectionModel model

nextButton

private nextapp.echo.Button nextButton

prevButton

private nextapp.echo.Button prevButton

cancelButton

private nextapp.echo.Button cancelButton

finishButton

private nextapp.echo.Button finishButton

placement

private int placement

scrollBarPolicy

private int scrollBarPolicy

titleBar

private TitleBar titleBar

wizardList

private java.util.ArrayList wizardList
Constructor Detail

WizardPane

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

WizardPane

public WizardPane(int buttonPlacement)
Constructs a new WizardPane

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()

add

public void add(nextapp.echo.Component component,
                int index)
Adds a component to the WizardPane at the specified index

Cover method for insert()

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.

addWizardNavigationListener

public void addWizardNavigationListener(echopoint.wizard.WizardNavigationListener l)
Adds a WizardNavigationListener to the WizardPane.

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 echopoint.positionable.Scrollable
Overrides:
applyStyle in class EchoPointComponent

checkAndSetSelectedIndex

private void checkAndSetSelectedIndex(int savedSelectedIndex,
                                      int toIndex)
This method will check that the currently selected index of the the WizardPane is still the same as a saved value. If not then it will NOT set the selected index. This is used during the WizardNavigationListener events to allow the listener a chance to set the selected index during the event processing, reagrdless of what is logically next. we * dont want to blat that away by blindly settting it to index+1 or index -1

fireOnNavigation

private void fireOnNavigation(int type,
                              nextapp.echo.Component fromComponent,
                              nextapp.echo.Component toComponent,
                              int fromIndex,
                              int toIndex)
                       throws echopoint.wizard.WizardNavigationVetoException
Called to notify all WizardNavigationListener's of a navigation event.

getBorderColor

public nextapp.echo.Color getBorderColor()

getBorderSize

public int getBorderSize()

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)

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()

getFooterAt

public java.lang.String getFooterAt(int 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 echopoint.positionable.Scrollable

getInsets

public nextapp.echo.Insets getInsets()
Returns the insets (margins) of the tabbed pane contents.

getModel

public echopoint.model.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()

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 echopoint.positionable.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 echopoint.positionable.Scrollable

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 echopoint.positionable.Scrollable

getSelectedComponent

public nextapp.echo.Component getSelectedComponent()

getSelectedIndex

public int getSelectedIndex()
Returns the currently selected index or -1 if none is selected

getTitle

public TitleBar getTitle()

getTitleAt

public java.lang.String getTitleAt(int 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 echopoint.positionable.Scrollable

getWizardEntryAt

private WizardPane.WizardEntry getWizardEntryAt(int index)
Returns the tab entry at a specified index. Returns null if the index is out of range.

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.

reArrangeVisibleComponents

private void reArrangeVisibleComponents(nextapp.echo.Component removedComponent)
Called to rearrange the components inside the WizardPane It moves the currently selected component into the visible container and the rest into the invisible bucket. This ensures that they get no rendering peers and hence this is more efficient.

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.

removeComponentAt

public void removeComponentAt(int index)
Removes a Component entry from the WizardPane at the specified index.

removeWizardNavigationListener

public void removeWizardNavigationListener(echopoint.wizard.WizardNavigationListener l)
Removes a WizardNavigationListener to the WizardPane.

reRegisterComponents

protected void reRegisterComponents(nextapp.echo.Component oldValue,
                                    nextapp.echo.Component newValue)
Adds and removes a Component as a child of the WizardPane.

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)
Description copied from class: nextapp.echo.Component
Sets whether the component is enabled.

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.

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 echopoint.positionable.Scrollable

setInsets

public void setInsets(nextapp.echo.Insets newValue)
Sets the insets (margins) of the WizardPane

setModel

public void setModel(echopoint.model.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

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 echopoint.positionable.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 echopoint.positionable.Scrollable

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 echopoint.positionable.Scrollable

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 echopoint.positionable.Scrollable

validate

public void validate()
Description copied from class: nextapp.echo.Component
Validates this component. This method will be called by the application container before the component is rendered. This method should be overridden if the component needs to be updated before being rendered. Validation occurs from the top of the component hierarchy down. Overriding methods should take care to first call super.validate() to ensure the superclass is validated as well.

If components above this one in the hierarchy are modified by an overriding implementation of this method, those components WILL NOT be automatically revalidated. Thus, performing such operations in validate() is not inadvisable.

Overrides:
validate in class EchoPointComponent

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception
Description copied from interface: echopoint.util.reflect.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 echopoint.util.reflect.ReflectionSetter
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> [ echopoint overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of echopoint.WizardPane JAVADOC | Sourc code of echopoint.WizardPane SOURCE | Download echopoint.WizardPane DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD