com.canoo.ulc.community.layout.application
Class ULCGridBagLayoutPane

java.lang.Object
  |
  +--com.ulcjava.base.application.ULCProxy
        |
        +--com.ulcjava.base.application.ULCComponent
              |
              +--com.canoo.ulc.community.layout.application.ULCAbstractLayoutPane
                    |
                    +--com.canoo.ulc.community.layout.application.ULCGridBagLayoutPane

All Implemented Interfaces:

com.ulcjava.base.shared.internal.ICallable, IDefaults, com.ulcjava.base.server.IProxy, Serializable

public class ULCGridBagLayoutPane

extends ULCAbstractLayoutPane

implements IDefaults

The ULCGridBagLayoutPane aligns widgets according to the concept of Swing's GridBagLayout. It provides most flexibility and allows for complex GUIs.

The GridBagPane class aligns components vertically and horizontally, without requiring that the components be of the same size. Each GridBagPane object maintains a dynamic rectangular grid of cells, with each component occupying one or more cells, called its display area.

Each component managed by a GridBagPane is associated with an instance of GridBagConstraints that specifies how the component is laid out within its display area.

How a GridBagPane object places a set of components depends on the GridBagConstraints object associated with each component, and on the minimum size and the preferred size of the components' containers.

To use the GridBagPane effectively, you must customize one or more of the GridBagConstraints objects that are associated with its components.

Author:

Etienne.Studer@canoo.com

See Also:

GridBagConstraints, java.awt.GridBagLayout, Serialized Form

Fields inherited from class com.ulcjava.base.application.ULCComponent

fFont, fLabel, fVisible, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW, z

Fields inherited from class com.ulcjava.base.application.ULCProxy

fIsUploaded, i

Fields inherited from interface com.ulcjava.base.shared.IDefaults

BOTTOM, BOX_CENTER_BOTTOM, BOX_CENTER_CENTER, BOX_CENTER_EXPAND, BOX_CENTER_TOP, BOX_EXPAND_BOTTOM, BOX_EXPAND_CENTER, BOX_EXPAND_EXPAND, BOX_EXPAND_TOP, BOX_LEFT_BOTTOM, BOX_LEFT_CENTER, BOX_LEFT_EXPAND, BOX_LEFT_TOP, BOX_RIGHT_BOTTOM, BOX_RIGHT_CENTER, BOX_RIGHT_EXPAND, BOX_RIGHT_TOP, CENTER, HORIZONTAL, LEADING, LEFT, MANDATORY_STYLE_BACKGROUND, MANDATORY_STYLE_BORDERED, MNEMONIC_INDICATOR, RIGHT, TABLE_MODEL_CELL_CHANGED, TABLE_MODEL_CONTENTS_CHANGED, TABLE_MODEL_ROWS_ADDED, TABLE_MODEL_ROWS_CHANGED, TABLE_MODEL_ROWS_REMOVED, TOP, TRAILING, VERTICAL

Constructor Summary

ULCGridBagLayoutPane()
Creates a new ULCGridBagLayoutPane instance.

Method Summary

void	add(ULCComponent component) Adds the specified component to this grid bag layout pane, applying the default constraints.
void	add(ULCComponent component, GridBagConstraints constraints) Adds the specified component to this grid bag layout pane, applying the specified constraints.
GridBagConstraints	getConstraints(ULCComponent component) Gets the constraints for the specified component in this grid bag layout pane.
protected com.ulcjava.base.shared.internal.Anything	internalConvertFromConstraints(Object constraints)
protected static com.ulcjava.base.shared.internal.Anything	internalConvertFromGridBagConstraints(GridBagConstraints constraints)
void	setConstraints(ULCComponent component, GridBagConstraints constraints) Sets the constraints for the specified component in this grid bag layout pane.
protected String	typeString()

Methods inherited from class com.canoo.ulc.community.layout.application.ULCAbstractLayoutPane

getComponent, getComponentConstraints, getComponentCount, getComponents, getPropertyPrefix, indexOf, internalConvert, internalConvertFromComponents, remove, saveState, setComponentConstraints

Methods inherited from class com.ulcjava.base.application.ULCComponent

addFocusListener, addKeyListener, getActionForKeyStroke, getBackground, getClientProperty, getConditionForKeyStroke, getCursor, getEnabler, getFont, getForeground, getHelpTarget, getHelpUrlString, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupMenu, getPreferredSize, getRegisteredKeyStrokes, getToolTipText, handleEvent, handleRequest, internalSetLabel, isEnabled, isVisible, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeFocusListener, removeKeyListener, repaint, requestFocus, resetKeyboardActions, revalidate, setBackground, setCursor, setEnabled, setEnabler, setFont, setForeground, setHelpDocument, setHelpDocument, setHelpTarget, setHelpUrlString, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPopupMenu, setPreferredSize, setToolTipText, setVisible, unregisterKeyboardAction

Methods inherited from class com.ulcjava.base.application.ULCProxy

distributeToListeners, equals, getId, getRef, internalAddChild, internalAddListener, internalConvertFromColor, internalConvertFromDimension, internalConvertFromFont, internalConvertFromInsets, internalConvertFromKeyStroke, internalConvertFromObject, internalConvertToKeyStroke, internalConvertToObject, internalGetChildren, internalInsertChild, internalRemoveAllChildren, internalRemoveChild, internalRemoveListener, isUploaded, markUncollectable, release, saveState, saveState, saveState, saveState, saveState, saveState, saveState, saveState, saveState, saveState, saveState, saveState, sendUI, sendUI, sendUI, update, update, update, update, update, update, update, update, update, update, update, upload

Methods inherited from class java.lang.Object

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

Constructor Detail

ULCGridBagLayoutPane

public ULCGridBagLayoutPane()

Creates a new ULCGridBagLayoutPane instance.

Method Detail

getConstraints

public GridBagConstraints getConstraints(ULCComponent component)

Gets the constraints for the specified component in this grid bag layout pane. A copy of the actual GridBagConstraints object is returned.

Parameters:

component - the component to be queried

Returns:

a copy of the constraint for the specified component in this grid bag layout pane or null if the component is not part of this pane

setConstraints

public void setConstraints(ULCComponent component,
                           GridBagConstraints constraints)

Sets the constraints for the specified component in this grid bag layout pane.

Parameters:

component - the component to be modified

constraints - the constraints to be applied

add

public void add(ULCComponent component)

Adds the specified component to this grid bag layout pane, applying the default constraints.

Overrides:

add in class ULCAbstractLayoutPane

Parameters:

component - the component to be added

add

public void add(ULCComponent component,
                GridBagConstraints constraints)

Adds the specified component to this grid bag layout pane, applying the specified constraints.

Parameters:

component - the component to be added

constraints - the constraints to be applied

internalConvertFromConstraints

protected com.ulcjava.base.shared.internal.Anything internalConvertFromConstraints(Object constraints)

Overrides:

internalConvertFromConstraints in class ULCAbstractLayoutPane

internalConvertFromGridBagConstraints

protected static com.ulcjava.base.shared.internal.Anything internalConvertFromGridBagConstraints(GridBagConstraints constraints)

typeString

protected String typeString()

Overrides:

typeString in class ULCProxy