Package adams.gui.wizard

Class ListPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.wizard.AbstractWizardPage

adams.gui.wizard.ListPage

All Implemented Interfaces:

LoggingSupporter, ImageObserver, MenuContainer, Serializable, Accessible

public class ListPage
extends AbstractWizardPage

Wizard page that use a BaseList for displaying a list of values. The selected values are available in the properties object using the key KEY_SELECTED, all available values using the key KEY_LIST (both lists are comma-separated). The latter is optional and not stored by default.

Version:

$Revision: 9915 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_LIST	key in the properties that contains the comma-separated list of all items.
static String	KEY_SELECTED	key in the properties that contains the comma-separated list of selected items.
protected boolean	m_AddFullList	whether to use store the full list of items in the properties as well.
protected BaseList	m_List	the parameter panel for displaying the parameters.

Fields inherited from class adams.gui.wizard.AbstractWizardPage

m_ButtonLoad, m_ButtonSave, m_FileChooser, m_Owner, m_PageCheck, m_PageName, m_PanelButtons, m_ProceedAction, m_ScrollPaneDescription, m_TextDescription, m_Valid

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
ListPage()	Default constructor.
ListPage(String pageName)	Initializes the page with the given page name.

Method Summary

Modifier and Type	Method	Description
boolean	getAddFullList()	Returns whether to store the full list of items (not just selected ones) in the properties as well.
BaseList	getList()	Returns the underlying parameter panel.
Properties	getProperties()	Returns the content of the page (ie parameters) as properties.
int	getSelectionMode()	Returns the selection mode.
protected void	initGUI()	Initializes the widets.
protected void	initialize()	Initializes the members.
void	setAddFullList(boolean value)	Sets whether to store the full list of items (not just selected ones) in the properties as well.
void	setProperties(Properties value)	Sets the content of the page (ie parameters) as properties.
void	setSelectedValues(String[] value)	Sets the initially selected list values.
void	setSelectedValues(List<String> value)	Sets the initially selected list values.
void	setSelectionMode(int value)	Sets the selection mode.
void	setValues(String[] value)	Sets list values.
void	setValues(List<String> value)	Sets list values.

Methods inherited from class adams.gui.wizard.AbstractWizardPage

canProceed, getDescription, getDescriptionHeight, getFileChooser, getLogger, getOwner, getPageCheck, getPageName, getProceedAction, invalidate, isButtonPanelVisible, isLoggingEnabled, isValid, loadProperties, saveProperties, setButtonPanelVisible, setDescription, setDescription, setDescriptionHeight, setOwner, setPageCheck, setPageName, setProceedAction, update, updateButtons, validate

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LIST

public static final String KEY_LIST

key in the properties that contains the comma-separated list of all items.

See Also:

Constant Field Values

KEY_SELECTED

public static final String KEY_SELECTED

key in the properties that contains the comma-separated list of selected items.

See Also:

Constant Field Values

m_List

protected BaseList m_List

the parameter panel for displaying the parameters.

m_AddFullList

protected boolean m_AddFullList

whether to use store the full list of items in the properties as well.

Constructor Detail

ListPage

public ListPage()

Default constructor.

ListPage

public ListPage(String pageName)

Initializes the page with the given page name.

Parameters:

pageName - the page name to use

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractWizardPage

initGUI

protected void initGUI()

Initializes the widets.

Overrides:

initGUI in class AbstractWizardPage

setSelectionMode

public void setSelectionMode(int value)

Sets the selection mode.

Parameters:

value - the mode

See Also:

JList.setSelectionMode(int)

getSelectionMode

public int getSelectionMode()

Returns the selection mode.

Returns:

the mode

See Also:

JList.setSelectionMode(int)

getList

public BaseList getList()

Returns the underlying parameter panel.

Returns:

the parameter panel

setValues

public void setValues(String[] value)

Sets list values.

Parameters:

value - the values

setValues

public void setValues(List<String> value)

Sets list values.

Parameters:

value - the values

setSelectedValues

public void setSelectedValues(String[] value)

Sets the initially selected list values.

Parameters:

value - the values

setSelectedValues

public void setSelectedValues(List<String> value)

Sets the initially selected list values.

Parameters:

value - the values

setAddFullList

public void setAddFullList(boolean value)

Sets whether to store the full list of items (not just selected ones) in the properties as well.

Parameters:

value - true if to add

getAddFullList

public boolean getAddFullList()

Returns whether to store the full list of items (not just selected ones) in the properties as well.

Returns:

true if to add

setProperties

public void setProperties(Properties value)

Sets the content of the page (ie parameters) as properties.

Specified by:

setProperties in class AbstractWizardPage

Parameters:

value - the parameters as properties

getProperties

public Properties getProperties()

Returns the content of the page (ie parameters) as properties.

Specified by:

getProperties in class AbstractWizardPage

Returns:

the parameters as properties