de.tif.jacob.core.definition
Interface IGUIElementDefinition

All Superinterfaces:

INamedObjectDefinition

public interface IGUIElementDefinition
extends INamedObjectDefinition

This interface represents GUI elements on an abstract level.

Method Summary

IGuiElement	createRepresentation(IApplicationFactory factory, IApplication app, IGuiElement parent) Method to create a concret GUI element out of this GUI element definition.
Caption	getCaption() Returns the caption of this GUI element.
int	getPaneIndex() Returns the pane index of this GUI element.
java.awt.Rectangle	getRectangle() Returns the graphical extension of this gui element.
int	getTabIndex() Returns the tabulator index of this GUI element.
boolean	isVisible() Returns the default visibility of this GUI element.

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getName, getProperty

Method Detail

getCaption

Caption getCaption()

Returns the caption of this GUI element.

Returns:

the caption of the GUI element or null if no caption is existing or supported for this type of GUI element.

getRectangle

java.awt.Rectangle getRectangle()

Returns the graphical extension of this gui element.

Returns:

the rectangle of the GUI element on the screen or null, if managed by container.

isVisible

boolean isVisible()

Returns the default visibility of this GUI element.

Returns:

the default visibility

getTabIndex

int getTabIndex()

Returns the tabulator index of this GUI element.

Returns:

the tabulator index of this GUI element within the corresponding group or -1 if the element does not participate within the groups tab group.

getPaneIndex

int getPaneIndex()

Returns the pane index of this GUI element.

Returns:

the pane index of this GUI element within the corresponding group.

createRepresentation

IGuiElement createRepresentation(IApplicationFactory factory,
                                 IApplication app,
                                 IGuiElement parent)

Method to create a concret GUI element out of this GUI element definition.

Note that this method is currently for internal use only!

Parameters:

factory - the application factory

app - the concret application object

parent - the parent GUI element

Returns:

the created GUI element