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

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

All Implemented Interfaces:

IEditable, IForm, IGridLayoutPaneContainer, ITitledGridLayoutPaneContainer

Direct Known Subclasses:

SectionForm, SimpleForm

public abstract class AbstractForm

extends AbstractTitledGridLayoutPaneContainer

implements IForm

This is the abstract base class for all forms. A form is a specially fomatted GridLayoutPaneContainer with a title and is intended to be used as the root pane for an editor. A form contains a GridLayoutPane as the user area, that can be filled by subclasses. The style of the form can be determined by supplying an implementation of com.tssap.util.ui.lfsupport.IWidgetFactory, e.g. DefaultWidgetFactory.

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

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

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

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

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

Method Summary

int	getColumns() Returns number of columns.
void	initContainer(IGridLayoutPane glp) Initializes the form by setting title and description fonts, creating a new user area and calling the initForm(GridLayoutPane) method from the interface IForm that must be implemented by subsclasses to fill the form.

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.form.IForm

initForm

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

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

isEditable, setEditable

Constructor Detail

AbstractForm

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

Creates a new AbstractForm 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.

AbstractForm

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

Creates a new AbstractForm 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

AbstractForm

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

Creates a new AbstractForm 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.

AbstractForm

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

Creates a new AbstractForm.

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

initContainer

public final void initContainer(IGridLayoutPane glp)

Initializes the form by setting title and description fonts, creating a new user area and calling the initForm(GridLayoutPane) method from the interface IForm that must be implemented by subsclasses to fill the form. Besides two other abstract methods are called before (preInitForm( GridLayoutPane)) and after (postInitForm(GrindLayoutPane) ) the initialization. Subclasses can implement these methods in case they want to supply addional layout at the top or at the bottom of the form (outside of the client area).

Specified by:

initContainer in interface IGridLayoutPaneContainer

Parameters:

glp - The client area of the super class to be filled within the abstract form.

getColumns

public int getColumns()

Returns number of columns.

Returns:

number of columns