com.tssap.util.ui.glpc
Class AbstractGridLayoutPaneContainer

java.lang.Object
  |
  +--com.tssap.util.ui.AbstractEditable
        |
        +--com.tssap.util.ui.glpc.AbstractGridLayoutPaneContainer

All Implemented Interfaces:

IEditable, IGridLayoutPaneContainer

Direct Known Subclasses:

AbstractTitledGridLayoutPaneContainer

public abstract class AbstractGridLayoutPaneContainer

extends AbstractEditable

implements IGridLayoutPaneContainer

Abstract base implemantation of IGridLayoutPaneContainer. It behaves like a container with a parent pane grid layout pane consisting of 3 columns (no equal widths). User are is embedded in the midway column. 3 abstract callback methods give an extending class the ability to place any additional UI components (= controls) around the user area and its content.

See Also:

composeGridLayoutPaneContainer(IGridLayoutPane, IWidgetFactory, IGridLayoutData)

Field Summary

static boolean

USER_GRID_DEFAULT_EQUAL_SIZE_FLAG default value for equal column width behavior

Constructor Summary

AbstractGridLayoutPaneContainer(IWidgetFactory widgetFactory, int userAreaColumns)

AbstractGridLayoutPaneContainer(IWidgetFactory widgetFactory, int userGridColumns, boolean userGridEqualColSize)

Method Summary

void	composeGridLayoutPaneContainer(IGridLayoutPane parentPane, IWidgetFactory widgetFactory, IGridLayoutData layoutData) Complete container (including user area) is composed within the following steps: 1. calls method preInitContainer(IGridLayoutPane parentPane) 2. calls method prepareContainer(IGridLayoutPane parentPane) 3. create and initialize user area 4. calls method postInitContainer(IGridLayoutPane parentPane) Can only be called one time.
IGridLayoutPane	getUserAreaGridLayoutPane() Gets the userAreaGridLayoutPane.
int	getUserGridNumOfColumns() Returns number of columns for userArea given to method initContainer(IGridLayoutPane userArea)
IWidgetFactory	getWidgetFactory() Returns the widgetFactory.
boolean	isComposable() Checks if container has already been composed.
boolean	isUserGridEqualColSize() Returns true if userArea given to method initContainer(IGridLayoutPane userArea) has to have equal column widths

Methods inherited from class com.tssap.util.ui.AbstractEditable

isEditable, setEditable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tssap.util.ui.glpc.IGridLayoutPaneContainer

initContainer

Methods inherited from interface com.tssap.util.ui.IEditable

isEditable, setEditable

Field Detail

USER_GRID_DEFAULT_EQUAL_SIZE_FLAG

public static final boolean USER_GRID_DEFAULT_EQUAL_SIZE_FLAG

default value for equal column width behavior

Constructor Detail

AbstractGridLayoutPaneContainer

public AbstractGridLayoutPaneContainer(IWidgetFactory widgetFactory,
                                       int userAreaColumns)

Parameters:

widgetFactory -

userAreaColumns -

AbstractGridLayoutPaneContainer

public AbstractGridLayoutPaneContainer(IWidgetFactory widgetFactory,
                                       int userGridColumns,
                                       boolean userGridEqualColSize)

Parameters:

widgetFactory -

userGridColumns -

userGridEqualColSize -

Method Detail

getUserGridNumOfColumns

public int getUserGridNumOfColumns()

Description copied from interface: IGridLayoutPaneContainer

Returns number of columns for userArea given to method initContainer(IGridLayoutPane userArea)

Specified by:

getUserGridNumOfColumns in interface IGridLayoutPaneContainer

See Also:

IGridLayoutPaneContainer.getUserGridNumOfColumns()

isUserGridEqualColSize

public boolean isUserGridEqualColSize()

Description copied from interface: IGridLayoutPaneContainer

Returns true if userArea given to method initContainer(IGridLayoutPane userArea) has to have equal column widths

Specified by:

isUserGridEqualColSize in interface IGridLayoutPaneContainer

See Also:

IGridLayoutPaneContainer.isUserGridEqualColSize()

composeGridLayoutPaneContainer

public void composeGridLayoutPaneContainer(IGridLayoutPane parentPane,
                                           IWidgetFactory widgetFactory,
                                           IGridLayoutData layoutData)

Complete container (including user area) is composed within the following steps: 1. calls method preInitContainer(IGridLayoutPane parentPane) 2. calls method prepareContainer(IGridLayoutPane parentPane) 3. create and initialize user area 4. calls method postInitContainer(IGridLayoutPane parentPane) Can only be called one time.

Parameters:

parentPane -

widgetFactory -

layoutData -

Throws:

a - ContainerFrameworkException will be called if method is called a second time.

See Also:

isComposable()

getUserAreaGridLayoutPane

public IGridLayoutPane getUserAreaGridLayoutPane()

Gets the userAreaGridLayoutPane.

Returns:

Returns a IGridLayoutPane

isComposable

public boolean isComposable()

Checks if container has already been composed.

Returns:

boolean false if container has already been composed.

getWidgetFactory

public IWidgetFactory getWidgetFactory()

Returns the widgetFactory. The widget factory is used to create all controls inside this container.

Returns:

IWidgetFactory container's widget factory