net.sf.jguiraffe.gui.builder.components

Class ComponentManagerWrapper

java.lang.Object

net.sf.jguiraffe.gui.builder.components.ComponentManagerWrapper

All Implemented Interfaces:

ComponentManager

public abstract class ComponentManagerWrapper
extends Object
implements ComponentManager

A base class for wrapper implementations of the ComponentManager interface.

An instance of this class is initialized with a reference to a ComponentManager object. All methods simply delegate to this object.

This class is especially useful if a custom implementation of ComponentManager is to be created based on an existing implementation. Then only the methods to be customized have to be implemented. All other methods can still delegate to the existing implementation.

Version:

$Id: ComponentManagerWrapper.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComponentManagerWrapper(ComponentManager wrapped) Creates a new instance of ComponentManagerWrapper and initializes it with the wrapped ComponentManager.

Method Summary

Modifier and Type	Method and Description
void	addContainerComponent(Object container, Object component, Object constraints) Adds a component to a container using the specified constraints.
Object	createBorderLayout(BorderLayoutTag tag) Creates a border layout object whose parameters are obtained form the specified tag.
ComponentHandler<Boolean>	createButton(ButtonTag tag, boolean create) Creates a button component.
Object	createButtonLayout(ButtonLayoutTag tag) Creates a button layout object whose parameters are obtained from the specified tag.
ComponentHandler<Boolean>	createCheckbox(CheckboxTag tag, boolean create) Creates a component handler that wraps a checkbox.
ComponentHandler<Object>	createComboBox(ComboBoxTag tag, boolean create) Creates a component handler that wraps a combo box.
Object	createDesktopPanel(DesktopPanelTag tag, boolean create) Creates a desktop panel whose parameters are obtained from the specified tag.
PlatformEventManager	createEventManager() Returns a concrete implementation of the PlatformEventManager interface for dealing with event notifications.
Object	createFont(FontTag tag) Creates a font object from the data specified by the given FontTag.
Object	createIcon(Locator locator) Creates an icon object with the data obtained from the specified Locator
Object	createLabel(LabelTag tag, boolean create) Creates a label object.
ComponentHandler<Object>	createListBox(ListBoxTag tag, boolean create) Creates a component handler that wraps a list box.
Object	createPanel(PanelTag tag, boolean create) Creates a panel whose parameters are obtained from the specified tag.
ComponentHandler<String>	createPasswordField(PasswordFieldTag tag, boolean create) Creates a ComponentHandler that wraps a password text field.
Object	createPercentLayout(PercentLayoutTag tag) Creates a percent layout object whose parameters are obtained from the specified tag.
ComponentHandler<Integer>	createProgressBar(ProgressBarTag tag, boolean create) Creates a component handler that wraps a progress bar element.
ComponentHandler<Boolean>	createRadioButton(RadioButtonTag tag, boolean create) Creates a component handler that wraps a radio button.
Object	createRadioGroup(Map<String,Object> radioButtons) Creates a radio group which contains the radio buttons stored in the passed in map.
ComponentHandler<Integer>	createSlider(SliderTag tag, boolean create) Creates a component handler that wraps a slider component.
Object	createSplitter(SplitterTag tag, boolean create) Creates a splitter whose parameters are obtained from the specified tag.
ComponentHandler<StaticTextData>	createStaticText(StaticTextTag tag, boolean create) Creates a component handler that wraps a static text element.
ComponentHandler<Integer>	createTabbedPane(TabbedPaneTag tag, boolean create) Creates a component handler that wraps a tabbed pane.
ComponentHandler<Object>	createTable(TableTag tag, boolean create) Creates a table based on the information stored in the passed in table tag.
ComponentHandler<String>	createTextArea(TextAreaTag tag, boolean create) Creates a component handler that wraps a text area.
ComponentHandler<String>	createTextField(TextFieldTag tag, boolean create) Creates a component handler that wraps a text field.
ComponentHandler<Boolean>	createToggleButton(ToggleButtonTag tag, boolean create) Creates a toggle button component.
ComponentHandler<Object>	createTree(TreeTag tag, boolean create) Creates a tree component based on the information stored in the passed in tree tag.
WidgetHandler	getWidgetHandlerFor(Object component) Returns a WidgetHandler for the specified component.
ComponentManager	getWrappedComponentManager() Returns a reference to the wrapped ComponentManager object.
void	linkLabel(Object label, Object component, String text) Associates a link with another component.
void	setContainerLayout(Object container, Object layout) Defines the layout manager for a container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentManagerWrapper

protected ComponentManagerWrapper(ComponentManager wrapped)

Creates a new instance of ComponentManagerWrapper and initializes it with the wrapped ComponentManager. Note: This method does not check whether the passed in ComponentManager object is null because we do not want to enforce this restriction on all subclasses. The passed in wrapped component manager is stored in an internal field and can be accessed using the getWrappedComponentManager() method. If a subclass needs another mechanism to access the wrapped manager, it has to override the getWrappedComponentManager() method.

Parameters:

wrapped - the wrapped ComponentManager

Method Detail

getWrappedComponentManager

public ComponentManager getWrappedComponentManager()

Returns a reference to the wrapped ComponentManager object.

Returns:

the wrapped ComponentManager object

addContainerComponent

public void addContainerComponent(Object container,
                                  Object component,
                                  Object constraints)

Adds a component to a container using the specified constraints. This method is called to populate container objects. Just delegates to the wrapped ComponentManager object.

Specified by:

addContainerComponent in interface ComponentManager

Parameters:

container - the container

component - the component which is to be added to the container

constraints - a generic constraints object; this object must be compatible with the layout manager set for the container; it may be null

setContainerLayout

public void setContainerLayout(Object container,
                               Object layout)

Defines the layout manager for a container. Just delegates to the wrapped ComponentManager object.

Specified by:

setContainerLayout in interface ComponentManager

Parameters:

container - the container

layout - the new layout manager

createEventManager

public PlatformEventManager createEventManager()

Returns a concrete implementation of the PlatformEventManager interface for dealing with event notifications. This method is called once when the event handling features are used for the first time. Just delegates to the wrapped ComponentManager object.

Specified by:

createEventManager in interface ComponentManager

Returns:

the platform specific event manager

getWidgetHandlerFor

public WidgetHandler getWidgetHandlerFor(Object component)

Returns a WidgetHandler for the specified component. This method is called by ComponentBuilderData when the user asks for a handler to a certain component. The passed in object is one of the components that was created during the last builder operation. An implementation may throw a runtime exception if a widget handler for the passed in component cannot be obtained. Just delegates to the wrapped ComponentManager object.

Specified by:

getWidgetHandlerFor in interface ComponentManager

Parameters:

component - the component

Returns:

a WidgetHandler wrapping the specified component

createLabel

public Object createLabel(LabelTag tag,
                          boolean create)
                   throws FormBuilderException

Creates a label object. All needed properties are extracted from the passed in tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createLabel in interface ComponentManager

Parameters:

tag - the label tag

create - the create flag

Returns:

the new label

Throws:

FormBuilderException - if an error occurs

linkLabel

public void linkLabel(Object label,
                      Object component,
                      String text)
               throws FormBuilderException

Associates a link with another component. This method will be called if the componentref attribute of a LabelTag was used to define a link between a lable and another component. An implementation will have to use library specific methods to establish such a connection. Eventually the label's text has to be set to the given text (this is the case if the label is undefined; its text is then obtained from the component's display name). Just delegates to the wrapped ComponentManager object.

Specified by:

linkLabel in interface ComponentManager

Parameters:

label - the label (as returned by the createLabel() method

component - the component to be linked to the label

text - an optional text to be set for the label; can be null, then no text has to be set

Throws:

FormBuilderException - if an error occurs

createIcon

public Object createIcon(Locator locator)
                  throws FormBuilderException

Creates an icon object with the data obtained from the specified Locator Just delegates to the wrapped ComponentManager object.

Specified by:

createIcon in interface ComponentManager

Parameters:

locator - the Locator pointing to the data

Returns:

the new icon object

Throws:

FormBuilderException - if an error occurs

createFont

public Object createFont(FontTag tag)
                  throws FormBuilderException

Creates a font object from the data specified by the given FontTag. Just delegates to the wrapped ComponentManager object.

Specified by:

createFont in interface ComponentManager

Parameters:

tag - the FontTag

Returns:

the newly created font

Throws:

FormBuilderException - if an error occurs

createPercentLayout

public Object createPercentLayout(PercentLayoutTag tag)
                           throws FormBuilderException

Creates a percent layout object whose parameters are obtained from the specified tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createPercentLayout in interface ComponentManager

Parameters:

tag - the percent layout tag

Returns:

the new layout object

Throws:

FormBuilderException - if an error occurs

createButtonLayout

public Object createButtonLayout(ButtonLayoutTag tag)
                          throws FormBuilderException

Creates a button layout object whose parameters are obtained from the specified tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createButtonLayout in interface ComponentManager

Parameters:

tag - the button layout tag

Returns:

the new layout object

Throws:

FormBuilderException - if an error occurs

createBorderLayout

public Object createBorderLayout(BorderLayoutTag tag)
                          throws FormBuilderException

Creates a border layout object whose parameters are obtained form the specified tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createBorderLayout in interface ComponentManager

Parameters:

tag - the border layout tag

Returns:

the new layout object

Throws:

FormBuilderException - if an error occurs

createPanel

public Object createPanel(PanelTag tag,
                          boolean create)
                   throws FormBuilderException

Creates a panel whose parameters are obtained from the specified tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createPanel in interface ComponentManager

Parameters:

tag - the panel tag

create - the create flag

Returns:

the new panel object

Throws:

FormBuilderException - if an error occurs

createDesktopPanel

public Object createDesktopPanel(DesktopPanelTag tag,
                                 boolean create)
                          throws FormBuilderException

Creates a desktop panel whose parameters are obtained from the specified tag. The desktop panel can be used as basic background for MDI child windows. Just delegates to the wrapped ComponentManager object.

Specified by:

createDesktopPanel in interface ComponentManager

Parameters:

tag - the desktop panel tag

create - the create flag

Returns:

the new desktop panel object

Throws:

FormBuilderException - if an error occurs

createSplitter

public Object createSplitter(SplitterTag tag,
                             boolean create)
                      throws FormBuilderException

Creates a splitter whose parameters are obtained from the specified tag. Just delegates to the wrapped ComponentManager object.

Specified by:

createSplitter in interface ComponentManager

Parameters:

tag - the splitter tag

create - the create flag

Returns:

the new splitter component

Throws:

FormBuilderException - if an error occurs

createRadioGroup

public Object createRadioGroup(Map<String,Object> radioButtons)
                        throws FormBuilderException

Creates a radio group which contains the radio buttons stored in the passed in map. Radio groups are treated as non visual components that merely implement the radio logic. They will not be inserted into a GUI container. The passed in map contains the names of the radio buttons as keys and the corresponding component objects as values. Just delegates to the wrapped ComponentManager object.

Specified by:

createRadioGroup in interface ComponentManager

Parameters:

radioButtons - a map with the radio button components that belong to the group

Returns:

the new radio group

Throws:

FormBuilderException - if an error occurs

createButton

public ComponentHandler<Boolean> createButton(ButtonTag tag,
                                              boolean create)
                                       throws FormBuilderException

Creates a button component. All needed properties are extracted from the passed in tag. Buttons (or to be more precise: command buttons) are considered as input components though they do not gather user input. The reason for this is that the event mechanism is coupled to ComponentHandler instances, so for a button to generate events there must be an associated component handler. Note that the returned component handler is usually not added to the generated Form object. If the button really should be used as input component, its data is a boolean value indicating whether the button is selected (which makes sense if the button is used as a toggle button). Just delegates to the wrapped ComponentManager object.

Specified by:

createButton in interface ComponentManager

Parameters:

tag - the button tag

create - the create flag

Returns:

the component handler for the new button

Throws:

FormBuilderException - if an error occurs

createToggleButton

public ComponentHandler<Boolean> createToggleButton(ToggleButtonTag tag,
                                                    boolean create)
                                             throws FormBuilderException

Creates a toggle button component. A toggle button is a simple switch that can be selected (pressed) or not. So the data associated with components of this type is simply a boolean. Just delegates to the wrapped ComponentManager object.

Specified by:

createToggleButton in interface ComponentManager

Parameters:

tag - the tag defining the toggle button

create - the create flag

Returns:

the component handler for the new toggle button

Throws:

FormBuilderException - if an error occurs

createTextField

public ComponentHandler<String> createTextField(TextFieldTag tag,
                                                boolean create)
                                         throws FormBuilderException

Creates a component handler that wraps a text field. The data type of this handler is String. Just delegates to the wrapped ComponentManager object.

Specified by:

createTextField in interface ComponentManager

Parameters:

tag - the tag defining the text field

create - the create flag

Returns:

the component handler for the text field

Throws:

FormBuilderException - if an error occurs

createTextArea

public ComponentHandler<String> createTextArea(TextAreaTag tag,
                                               boolean create)
                                        throws FormBuilderException

Creates a component handler that wraps a text area. The data type of this handler is String. Just delegates to the wrapped ComponentManager object.

Specified by:

createTextArea in interface ComponentManager

Parameters:

tag - the tag defining the text area

create - the create flag

Returns:

the component handler for the text area

Throws:

FormBuilderException - if an error occurs

createPasswordField

public ComponentHandler<String> createPasswordField(PasswordFieldTag tag,
                                                    boolean create)
                                             throws FormBuilderException

Creates a ComponentHandler that wraps a password text field. This handler acts like a regular handler for text input fields. Only the visual representation is different because the characters typed by the user in the text field are not readable. Just delegates to the wrapped ComponentManager object.

Specified by:

createPasswordField in interface ComponentManager

Parameters:

tag - the tag defining the password text field

create - the create flag

Returns:

the ComponentHandler for the password text field

Throws:

FormBuilderException - if an error occurs

createCheckbox

public ComponentHandler<Boolean> createCheckbox(CheckboxTag tag,
                                                boolean create)
                                         throws FormBuilderException

Creates a component handler that wraps a checkbox. This handler's data is of type boolean. Just delegates to the wrapped ComponentManager object.

Specified by:

createCheckbox in interface ComponentManager

Parameters:

tag - the tag defining the checkbox

create - the create flag

Returns:

the component handler for the checkbox

Throws:

FormBuilderException - if an error occurs

createRadioButton

public ComponentHandler<Boolean> createRadioButton(RadioButtonTag tag,
                                                   boolean create)
                                            throws FormBuilderException

Creates a component handler that wraps a radio button. This handler's data is of type boolean. Just delegates to the wrapped ComponentManager object.

Specified by:

createRadioButton in interface ComponentManager

Parameters:

tag - the tag defining the radio button

create - the create flag

Returns:

the component handler for the radio button

Throws:

FormBuilderException - if an error occurs

createComboBox

public ComponentHandler<Object> createComboBox(ComboBoxTag tag,
                                               boolean create)
                                        throws FormBuilderException

Creates a component handler that wraps a combo box. This handler maintains a single data object of the same type as the combo box's list model. Just delegates to the wrapped ComponentManager object.

Specified by:

createComboBox in interface ComponentManager

Parameters:

tag - the tag defining the combo box

create - the create flag

Returns:

the component handler for the combo box

Throws:

FormBuilderException - if an error occurs

createListBox

public ComponentHandler<Object> createListBox(ListBoxTag tag,
                                              boolean create)
                                       throws FormBuilderException

Creates a component handler that wraps a list box. This handler's data type is based on the type of the list's model and on the list's multi selection flag: for a single selection list the type is the same as the list's model's type, for a multi selection list it is an array of this type. Just delegates to the wrapped ComponentManager object.

Specified by:

createListBox in interface ComponentManager

Parameters:

tag - the tag defining the list box

create - the create flag

Returns:

the component handler for the list box

Throws:

FormBuilderException - if an error occurs

createTabbedPane

public ComponentHandler<Integer> createTabbedPane(TabbedPaneTag tag,
                                                  boolean create)
                                           throws FormBuilderException

Creates a component handler that wraps a tabbed pane. The handler's data consists of a single Integer object, which represents the (0-based) index of the selected tab. It can be read and set. Just delegates to the wrapped ComponentManager object.

Specified by:

createTabbedPane in interface ComponentManager

Parameters:

tag - the tag defining the tabbed pane

create - the create flag

Returns:

the component handler for the tabbed pane

Throws:

FormBuilderException - if an error occurs

createStaticText

public ComponentHandler<StaticTextData> createStaticText(StaticTextTag tag,
                                                         boolean create)
                                                  throws FormBuilderException

Creates a component handler that wraps a static text element. The handler's data consists of a StaticTextData object, which can be used to read and write the static text's properties. The returned handler can be casted into a StaticTextHandler object; the additional methods defined by this interface can be used to directly set the key properties of the static text component. Just delegates to the wrapped ComponentManager object.

Specified by:

createStaticText in interface ComponentManager

Parameters:

tag - the tag defining the static text

create - the create flag

Returns:

the component handler for the static text

Throws:

FormBuilderException - if an error occurs

createProgressBar

public ComponentHandler<Integer> createProgressBar(ProgressBarTag tag,
                                                   boolean create)
                                            throws FormBuilderException

Creates a component handler that wraps a progress bar element. The handler's data is an integer value representing the current position of the progress bar. The handler can be casted into a ProgressBarHandler object; the additional methods defined by this interface can be used to manipulate further properties of the progress bar. Just delegates to the wrapped ComponentManager object.

Specified by:

createProgressBar in interface ComponentManager

Parameters:

tag - the tag defining the progress bar

create - the create flag

Returns:

the component handler for the progress bar

Throws:

FormBuilderException - if an error occurs

createSlider

public ComponentHandler<Integer> createSlider(SliderTag tag,
                                              boolean create)
                                       throws FormBuilderException

Creates a component handler that wraps a slider component. The handler's data is an integer value representing the current value of the slider. Just delegates to the wrapped ComponentManager object.

Specified by:

createSlider in interface ComponentManager

Parameters:

tag - the tag defining the slider

create - the create flag

Returns:

the component handler for the slider

Throws:

FormBuilderException - if an error occurs

createTable

public ComponentHandler<Object> createTable(TableTag tag,
                                            boolean create)
                                     throws FormBuilderException

Creates a table based on the information stored in the passed in table tag. This is a complex operation because it has to be ensured that the table is fully initialized. It is guaranteed that the tag contains only valid data. The table's data model, its columns, and form objects to be used for rendering or editing cells are available. The returned ComponentHandler object wraps the table component. It can be casted into a TableHandler object. Its data depends on the selection type of the table: in single selection mode it is the index of the selected row; in multi selection mode it is an int[] with the indices of the selected rows. By registering a change listener at the returned ComponentHandler interested components can be notified when the table's selection changes. Just delegates to the wrapped ComponentManager object.

Specified by:

createTable in interface ComponentManager

Parameters:

tag - the table tag

create - the create flag

Returns:

the component handler for the new table component

Throws:

FormBuilderException - if an error occurs

createTree

public ComponentHandler<Object> createTree(TreeTag tag,
                                           boolean create)
                                    throws FormBuilderException

Creates a tree component based on the information stored in the passed in tree tag. The tag has been fully initialized, it especially contains the model to be used for the tree. The ComponentHandler returned by this method can be casted into a TreeHandler object. Refer to the documentation of this class for more information about the data supported by this handler. Just delegates to the wrapped ComponentManager object.

Specified by:

createTree in interface ComponentManager

Parameters:

tag - the tree tag

create - the create flag

Returns:

the component handler for the new tree component

Throws:

FormBuilderException - if an error occurs