HiRISE.HiPlan.HiWeb

Class GridBagPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

HiRISE.HiPlan.HiWeb.GridBagPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class GridBagPanel
extends javax.swing.JPanel

A JPanel with a GridBagLayout and utility methods to add and constrain components easily. Conceptually, this is very similar to an HTML Table, where a table cell can span multiple rows and/or columns. In addition, the Anchor (alignment) and fill (expansion) can be specified for a component.

Version:

1.6

Author:

Guy McArthur - UA/PIRL

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ANCHOR By default, anchor to the left
static int	DEFAULT_FILL By default, fill horizontally, not vertically
static java.awt.Insets	DEFAULT_INSETS By default, 1 pixel of margin surrounding component
static int	DEFAULT_PADDING_X Default padding on X axis
static int	DEFAULT_PADDING_Y Default padding on Y axis
static double	DEFAULT_WEIGHT_X Default weight on X axis
static double	DEFAULT_WEIGHT_Y Default weight on Y axis
static java.lang.String	ID Class identification name with source code version and date.

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
GridBagPanel() Create a new GridBagPanel.

Method Summary

Modifier and Type	Method and Description
void	add(java.awt.Component component, int row, int col) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int anchor) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int rspan, int cspan) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int rspan, int cspan, int anchor, int fill) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int rspan, int cspan, int anchor, int fill, double wx, double wy) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int rspan, int cspan, int anchor, int fill, double wx, double wy, int padx, int pady) Add a component to the Panel, constraining it with the given parameters.
void	add(java.awt.Component component, int row, int col, int rspan, int cspan, int anchor, int fill, double wx, double wy, int padx, int pady, java.awt.Insets insets) Add a component to the Panel, constraining it with the given parameters.
java.awt.Dimension	getMaximumSize() Get the maximum size of the component.
java.awt.Dimension	getPreferredSize() Get the preferred size of the component.

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, getMinimumSize, getNextFocusableComponent, getPopupLocation, 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, 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

ID

public static final java.lang.String ID

Class identification name with source code version and date.

See Also:

Constant Field Values

DEFAULT_ANCHOR

public static final int DEFAULT_ANCHOR

By default, anchor to the left

See Also:

Constant Field Values

DEFAULT_FILL

public static final int DEFAULT_FILL

By default, fill horizontally, not vertically

See Also:

Constant Field Values

DEFAULT_WEIGHT_X

public static final double DEFAULT_WEIGHT_X

Default weight on X axis

See Also:

Constant Field Values

DEFAULT_WEIGHT_Y

public static final double DEFAULT_WEIGHT_Y

Default weight on Y axis

See Also:

Constant Field Values

DEFAULT_PADDING_X

public static final int DEFAULT_PADDING_X

Default padding on X axis

See Also:

Constant Field Values

DEFAULT_PADDING_Y

public static final int DEFAULT_PADDING_Y

Default padding on Y axis

See Also:

Constant Field Values

DEFAULT_INSETS

public static final java.awt.Insets DEFAULT_INSETS

By default, 1 pixel of margin surrounding component

Constructor Detail

GridBagPanel

public GridBagPanel()

Create a new GridBagPanel.

Method Detail

getPreferredSize

public java.awt.Dimension getPreferredSize()

Get the preferred size of the component. For compactness, this overrides the superclass and returns the minimum size.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

The preferred size

getMaximumSize

public java.awt.Dimension getMaximumSize()

Get the maximum size of the component. For looks, this overrides the superclass and returns the minimum height but maximum width.

Overrides:

getMaximumSize in class javax.swing.JComponent

Returns:

The preferred size

add

public void add(java.awt.Component component,
                int row,
                int col)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

add

public void add(java.awt.Component component,
                int row,
                int col,
                int anchor)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

anchor - GridBagConstraints anchor

add

public void add(java.awt.Component component,
                int row,
                int col,
                int rspan,
                int cspan)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

rspan - Row span

cspan - Col span

add

public void add(java.awt.Component component,
                int row,
                int col,
                int rspan,
                int cspan,
                int anchor,
                int fill)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

rspan - Row span

cspan - Col span

anchor - GridBagLayout anchor

fill - GridBagLayout fill

add

public void add(java.awt.Component component,
                int row,
                int col,
                int rspan,
                int cspan,
                int anchor,
                int fill,
                double wx,
                double wy)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

rspan - Row span

cspan - Col span

anchor - GridBagLayout anchor

fill - GridBagLayout fill

wx - Weight along X axis

wy - Weight along Y axis

add

public void add(java.awt.Component component,
                int row,
                int col,
                int rspan,
                int cspan,
                int anchor,
                int fill,
                double wx,
                double wy,
                int padx,
                int pady)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

rspan - Row span

cspan - Col span

anchor - GridBagLayout anchor

fill - GridBagLayout fill

wx - Weight along X axis

wy - Weight along Y axis

padx - Padding on X axis

pady - Padding on Y axis

add

public void add(java.awt.Component component,
                int row,
                int col,
                int rspan,
                int cspan,
                int anchor,
                int fill,
                double wx,
                double wy,
                int padx,
                int pady,
                java.awt.Insets insets)

Add a component to the Panel, constraining it with the given parameters.

Parameters:

component - The component

row - Row number

col - Col number

rspan - Row span

cspan - Col span

anchor - GridBagLayout anchor

fill - GridBagLayout fill

wx - Weight along X axis

wy - Weight along Y axis

padx - Padding on X axis

pady - Padding on Y axis

insets - Margin