com.tssap.util.ui.glpc.section
Class SimpleSection

java.lang.Object
  |
  +--com.tssap.util.ui.AbstractEditable
        |
        +--com.tssap.util.ui.glpc.AbstractGridLayoutPaneContainer
              |
              +--com.tssap.util.ui.glpc.AbstractTitledGridLayoutPaneContainer
                    |
                    +--com.tssap.util.ui.glpc.section.AbstractSection
                          |
                          +--com.tssap.util.ui.glpc.section.SimpleSection

All Implemented Interfaces:

IEditable, IGridLayoutPaneContainer, ISection, ISimpleSection, ITitledGridLayoutPaneContainer

public final class SimpleSection

extends AbstractSection

implements ISimpleSection

This class represents a standard simple section that can be used to add any UI components. It provides a title and a description at its top that is displayed in the default section style. The look and feel of the Section can be set by using different WidgetFactories while creating the section. This class is not intended to be subclassed.

Fields inherited from class com.tssap.util.ui.glpc.AbstractTitledGridLayoutPaneContainer

DEFAULT_DESCRIPTION, DEFAULT_TITLE

Fields inherited from class com.tssap.util.ui.glpc.AbstractGridLayoutPaneContainer

USER_GRID_DEFAULT_EQUAL_SIZE_FLAG

Constructor Summary

SimpleSection(IWidgetFactory widgetFactory, int columns, boolean equalColumns, java.lang.String title, java.lang.String description)
Creates a new SimpleSection.

SimpleSection(IWidgetFactory widgetFactory, int columns, java.lang.String title, java.lang.String description)
Creates a new SimpleSection.

Method Summary

IGridLayoutPane	getClientArea() Returns the client area.
void	initSection(IGridLayoutPane glp) Initializes the client area of this grid layout pane container subclass.

Methods inherited from class com.tssap.util.ui.glpc.section.AbstractSection

initContainer

Methods inherited from class com.tssap.util.ui.glpc.AbstractTitledGridLayoutPaneContainer

getDescription, getTitle, setDescription, setTitle

Methods inherited from class com.tssap.util.ui.glpc.AbstractGridLayoutPaneContainer

composeGridLayoutPaneContainer, getUserAreaGridLayoutPane, getUserGridNumOfColumns, getWidgetFactory, isComposable, isUserGridEqualColSize

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.ITitledGridLayoutPaneContainer

getDescription, getTitle, setDescription, setTitle

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

getUserGridNumOfColumns, initContainer, isUserGridEqualColSize

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

isEditable, setEditable

Constructor Detail

SimpleSection

public SimpleSection(IWidgetFactory widgetFactory,
                     int columns,
                     java.lang.String title,
                     java.lang.String description)

Creates a new SimpleSection.

Parameters:

widgetFactory - The widget factory to use to create any child UI elements.

columns - The number of columns for the client area.

title - The title for the SimpleSection.

description - The description for the SimpleSection. If no description is given, it is empty by default.

SimpleSection

public SimpleSection(IWidgetFactory widgetFactory,
                     int columns,
                     boolean equalColumns,
                     java.lang.String title,
                     java.lang.String description)

Creates a new SimpleSection.

Parameters:

widgetFactory - The widget factory to use to create any child UI elements.

columns - The number of columns for the client area.

equalColumns - If this flag is set to true, all columns of the client area will have the same width, regardless of their content.

title - The title for the SimpleSection.

description - The description for the SimpleSection. If no description is given, it is empty by default.

Method Detail

initSection

public void initSection(IGridLayoutPane glp)

Initializes the client area of this grid layout pane container subclass. By default the client area is empty and can be filled with any UI element by the user of this class. The implementation of this method within this class simple stores the reference in a member variable for later access.

Specified by:

initSection in interface ISection

Parameters:

gridLayoutPane - The client area of the grid layout pane container subclass.

getClientArea

public IGridLayoutPane getClientArea()

Returns the client area. This area is empty by default and can be used to add any component.

Specified by:

getClientArea in interface ISimpleSection

Returns:

The client area defined by this grid layout pane container subsclass.