com.tssap.util.ui.glpc.form
Class SimpleForm

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.form.AbstractForm
                          |
                          +--com.tssap.util.ui.glpc.form.SimpleForm

All Implemented Interfaces:

IEditable, IForm, IGridLayoutPaneContainer, ISimpleForm, ITitledGridLayoutPaneContainer

public final class SimpleForm

extends AbstractForm

implements ISimpleForm

This class represents a standard simple form that can be used to add any UI elements. It provides a title and a description at its top that is displayed in the default form style. The look and feel of the form can be set by using different WidgetFactories while creating the form. 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

SimpleForm(IWidgetFactory widgetFactory, int columns, boolean equalColumns, java.lang.String title)
Creates a new SimpleForm with an empty description.

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

SimpleForm(IWidgetFactory widgetFactory, int columns, java.lang.String title)
Creates a new SimpleForm with no description and non-equal column widths.

SimpleForm(IWidgetFactory widgetFactory, int columns, java.lang.String title, java.lang.String description)
Creates a new SimpleForm with non-equal column widths.

Method Summary

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

Methods inherited from class com.tssap.util.ui.glpc.form.AbstractForm

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

SimpleForm

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

Creates a new SimpleForm with no description and non-equal column widths.

Parameters:

widgetFactory - The WidgetFactory to use.

columns - The number of columns the client area should have.

title - The title of the form.

SimpleForm

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

Creates a new SimpleForm with non-equal column widths.

Parameters:

widgetFactory - The WidgetFactory to use.

columns - The number of columns the client area should have.

title - The title of the form.

description - The description of the form

SimpleForm

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

Creates a new SimpleForm with an empty description.

Parameters:

widgetFactory - The WidgetFactory to use.

columns - The number of columns the client area should have.

equalColumns - Flag if the columns should have equal width.

title - The title of the form.

SimpleForm

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

Creates a new SimpleForm.

Parameters:

widgetFactory - The WidgetFactory to use.

columns - The number of columns the client area should have.

equalColumns - Flag if the columns should have equal width.

title - The title of the form.

description - The description of the form

Method Detail

initForm

public void initForm(IGridLayoutPane gridLayoutPane)

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 simply stores the reference in a member variable for later access.

Specified by:

initForm in interface IForm

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 ISimpleForm

Returns:

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