meka.gui.core

Class ParameterPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

meka.gui.core.ParameterPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ClassifyTabOptions

public class ParameterPanel
extends JPanel

A panel that lists one parameter (label and component or just AbstractChooserPanel) per row. The sizes of the labels get automatically adjusted.

Version:

$Revision$

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 and Description
protected int	m_GapHorizontal the horizontal gap.
protected int	m_GapVertical the vertical gap.
protected Vector<JLabel>	m_Labels the labels.
protected Vector<Component>	m_Parameters the parameters.
protected Dimension	m_PreferredDimensionJSpinner the preferred dimensions for JSpinner components.
protected Vector<JPanel>	m_Rows the panels that make up the rows.

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 and Description
ParameterPanel() Initializes the panel.
ParameterPanel(int hgap, int vgap) Initializes the panel.

Method Summary

Modifier and Type	Method and Description
void	addParameter(int index, String label, Component comp) Inserts the label and component as new row at the specified row.
void	addParameter(String label, Component comp) Adds the label and component as new row at the end.
void	clearParameters() Removes all parameters.
JLabel	getLabel(int index) Returns the label for the parameter at the specified location.
Component	getParameter(int index) Returns the parameter component at the specified location.
int	getParameterCount() Returns the number of parameters currently displayed.
Dimension	getPreferredDimensionJSpinner() Returns the preferred dimension for JSpinner and derived classes.
protected void	initGUI() Initializes the members.
protected void	initialize() Initializes the members.
void	removeParameter(int index) Removes the parameter at the specified location.
void	setEnabled(boolean enabled) Sets the enabled state of the panel.
void	setPreferredDimensionJSpinner(Dimension value) Sets the preferred dimension for JSpinner and derived classes.
protected void	update() Updates the layout.

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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, invalidate, 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, validate, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

m_Rows

protected Vector<JPanel> m_Rows

the panels that make up the rows.

m_Labels

protected Vector<JLabel> m_Labels

the labels.

m_Parameters

protected Vector<Component> m_Parameters

the parameters.

m_GapHorizontal

protected int m_GapHorizontal

the horizontal gap.

m_GapVertical

protected int m_GapVertical

the vertical gap.

m_PreferredDimensionJSpinner

protected Dimension m_PreferredDimensionJSpinner

the preferred dimensions for JSpinner components.

Constructor Detail

ParameterPanel

public ParameterPanel()

Initializes the panel.

ParameterPanel

public ParameterPanel(int hgap,
                      int vgap)

Initializes the panel.

Parameters:

hgap - the horizontal gap in pixel

vgap - the vertical gap in pixel

Method Detail

initialize

protected void initialize()

Initializes the members.

initGUI

protected void initGUI()

Initializes the members.

clearParameters

public void clearParameters()

Removes all parameters.

setPreferredDimensionJSpinner

public void setPreferredDimensionJSpinner(Dimension value)

Sets the preferred dimension for JSpinner and derived classes.

Parameters:

value - the preferred dimensions (do not use 0 for height!)

getPreferredDimensionJSpinner

public Dimension getPreferredDimensionJSpinner()

Returns the preferred dimension for JSpinner and derived classes.

Returns:

the preferred dimensions

addParameter

public void addParameter(String label,
                         Component comp)

Adds the label and component as new row at the end.

Parameters:

label - the label to add, the mnemonic to use is preceded by "_"

comp - the component to add

addParameter

public void addParameter(int index,
                         String label,
                         Component comp)

Inserts the label and component as new row at the specified row.

Parameters:

label - the label to add, the mnemonic to use is preceded by "_"

comp - the component to add

index - the row index to insert the label/editfield at, -1 will add the component at the end

removeParameter

public void removeParameter(int index)

Removes the parameter at the specified location.

Parameters:

index - the row index

getParameter

public Component getParameter(int index)

Returns the parameter component at the specified location.

Parameters:

index - the row index

Returns:

the requested component

getParameterCount

public int getParameterCount()

Returns the number of parameters currently displayed.

Returns:

the number of rows

getLabel

public JLabel getLabel(int index)

Returns the label for the parameter at the specified location.

Parameters:

index - the row index

Returns:

the requested label

update

protected void update()

Updates the layout.

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled state of the panel.

Overrides:

setEnabled in class JComponent

Parameters:

enabled - if true then the parameters will be editable