Package adams.gui.core

Class AdjustableGridPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.AdjustableGridPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class AdjustableGridPanel
extends BasePanel

Panel with GridLayout that allows user to adjust layout.

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	Description
protected BaseButton	m_ButtonApply	the button for applying the dimensions.
protected int	m_Columns	the columns.
protected List<Component>	m_Items	the items to display.
protected JPanel	m_PanelContent	the panel for the actual content.
protected JPanel	m_PanelControl	the panel with the dimensions.
protected int	m_Rows	the rows.
protected JSpinner	m_SpinnerColumns	the spinner for the columns.
protected JSpinner	m_SpinnerRows	the spinner for 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	Description
AdjustableGridPanel()	Initializes the panel with just one row.
AdjustableGridPanel(int rows, int cols)	Initializes the panel with specified dimensions, no items.
AdjustableGridPanel(int rows, int cols, Component[] items)	Initializes the panel with specified dimensions and items.
AdjustableGridPanel(int rows, int cols, List<Component> items)	Initializes the panel with specified dimensions and items.

Method Summary

Modifier and Type	Method	Description
void	additem(int index, Component comp)	Adds the component and updates the layout.
void	addItem(Component comp)	Adds the component and updates the layout.
void	clear()	Removes all components.
int	getColumns()	Returns the number of columns displayed.
boolean	getControlsVisible()	Returns whether the controls are show or not.
Component	getItem(int index)	Returns the specified component.
int	getRows()	Returns the number of rows displayed.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
int	numItems()	Returns the number of components.
void	removeItem(int index)	Removes the component and updates the layout.
void	setColumns(int value)	Updates the columns to display.
void	setControlsVisible(boolean value)	Sets whether the controls are shown or not.
void	setGrid(int rows, int cols)	Updates rows and columns to display.
void	setRows(int value)	Updates the rows to display.
void	updateLayout()	Updates the layout.

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, 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, 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, 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

m_Rows

protected int m_Rows

the rows.

m_Columns

protected int m_Columns

the columns.

m_Items

protected List<Component> m_Items

the items to display.

m_PanelControl

protected JPanel m_PanelControl

the panel with the dimensions.

m_SpinnerRows

protected JSpinner m_SpinnerRows

the spinner for the rows.

m_SpinnerColumns

protected JSpinner m_SpinnerColumns

the spinner for the columns.

m_ButtonApply

protected BaseButton m_ButtonApply

the button for applying the dimensions.

m_PanelContent

protected JPanel m_PanelContent

the panel for the actual content.

Constructor Detail

AdjustableGridPanel

public AdjustableGridPanel()

Initializes the panel with just one row.

AdjustableGridPanel

public AdjustableGridPanel(int rows,
                           int cols)

Initializes the panel with specified dimensions, no items.

Parameters:

rows - the number of rows

cols - the number of columns

AdjustableGridPanel

public AdjustableGridPanel(int rows,
                           int cols,
                           Component[] items)

Initializes the panel with specified dimensions and items.

Parameters:

rows - the number of rows

cols - the number of columns

items - the items to display

AdjustableGridPanel

public AdjustableGridPanel(int rows,
                           int cols,
                           List<Component> items)

Initializes the panel with specified dimensions and items.

Parameters:

rows - the number of rows

cols - the number of columns

items - the items to display

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

updateLayout

public void updateLayout()

Updates the layout.

clear

public void clear()

Removes all components.

addItem

public void addItem(Component comp)

Adds the component and updates the layout.

Parameters:

comp - the component to add

additem

public void additem(int index,
                    Component comp)

Adds the component and updates the layout.

Parameters:

index - the index to add the component at

comp - the component to add

removeItem

public void removeItem(int index)

Removes the component and updates the layout.

Parameters:

index - the index of the component to remove

getItem

public Component getItem(int index)

Returns the specified component.

Parameters:

index - the index of the component to return

Returns:

the component

numItems

public int numItems()

Returns the number of components.

Returns:

the number

setRows

public void setRows(int value)

Updates the rows to display.

Parameters:

value - the new number of rows

getRows

public int getRows()

Returns the number of rows displayed.

Returns:

the rows

setColumns

public void setColumns(int value)

Updates the columns to display.

Parameters:

value - the new number of columns

getColumns

public int getColumns()

Returns the number of columns displayed.

Returns:

the columns

setGrid

public void setGrid(int rows,
                    int cols)

Updates rows and columns to display.

Parameters:

rows - the rows

cols - the columns

setControlsVisible

public void setControlsVisible(boolean value)

Sets whether the controls are shown or not.

Parameters:

value - true if to show controls

getControlsVisible

public boolean getControlsVisible()

Returns whether the controls are show or not.

Returns:

true if controls shown