| java.lang.Object
 org.beryl.gui.AbstractView
org.beryl.gui.Widget
All known Subclasses: org.beryl.gui.widgets.Menu, org.beryl.gui.widgets.Item, org.beryl.gui.widgets.MenuBar, org.beryl.gui.widgets.ToolBar, org.beryl.gui.widgets.SplitPane, org.beryl.gui.widgets.SyntaxEditor, org.beryl.gui.widgets.Console, org.beryl.gui.widgets.Button, org.beryl.gui.widgets.FileField, org.beryl.gui.widgets.PopupMenu, org.beryl.gui.widgets.RadioButton, org.beryl.gui.widgets.Spacer, org.beryl.gui.widgets.MenuItem, org.beryl.gui.widgets.Panel, org.beryl.gui.widgets.Label, org.beryl.gui.widgets.TabbedPane, org.beryl.gui.widgets.Tree, org.beryl.gui.widgets.Table, org.beryl.gui.widgets.List, org.beryl.gui.widgets.IconView, org.beryl.gui.widgets.TextPane, org.beryl.gui.widgets.Frame, org.beryl.gui.widgets.CheckBox, org.beryl.gui.widgets.OutlookBar, org.beryl.gui.widgets.Separator, org.beryl.gui.widgets.ProgressBar, org.beryl.gui.widgets.ComboBox, org.beryl.gui.widgets.Dialog, org.beryl.gui.widgets.Wizard, org.beryl.gui.widgets.OutlookPanel, org.beryl.gui.widgets.TextField,
| Widget | | abstract public class Widget extends AbstractView implements LFConstants(Code) | | Widget is the base class of all components using the
Beryl XML GUI framework.
|
| constraints | | protected static HIGConstraints constraints(Code) | | |
| helpBroker | | protected static HelpBroker helpBroker(Code) | | |
| helpSet | | protected static HelpSet helpSet(Code) | | |
| Widget | | public Widget(Widget parent, String name, String preset) throws GUIException(Code) | | Create a widget with a predefined type
Parameters:
parent - The widget's parent
Parameters:
name - The name of the widget
Parameters:
preset - The preset to use
throws:
GUIException - If something goes wrong during the construction |
| Widget | | public Widget(Widget parent, String name) throws GUIException(Code) | | Create a widget
Parameters:
parent - The widget's parent
Parameters:
name - The name of the widget
throws:
GUIException - If something goes wrong during the construction |
| addListener | | public void addListener(String event, String name, GUIEventListener listener) throws GUIException(Code) | | Add a listener for a given event
Every widget can support DnD, to enable it add a "drag"
event or an event in the form "drop[mimeType1,mimeType2]"
|
| addValidator | | public void addValidator(Validator validator)(Code) | | Add a validator to this widget
|
| dumpStructure | | public String dumpStructure()(Code) | | Return an ASCII-Art representation of the tree
|
| finalizeConstruction | | public void finalizeConstruction() throws GUIException(Code) | | This is called after a component has been completely constructed
from an XML description file. Can be overwritten by subclasses if
such funtionality is required.
|
| getChild | | public Widget getChild(int index)(Code) | | Return the child widget at the given index
|
| getChildCount | | public int getChildCount()(Code) | | Return the amount of child widgets
|
| getChildIndex | | public int getChildIndex(Widget child)(Code) | | Return the index of a child
|
| getChildWidgetByName | | public Widget getChildWidgetByName(String name)(Code) | | Recursively search the widget tree for
a child widget
|
| getChildren | | final protected List getChildren()(Code) | | Return a structure containing the widget's children
|
| getHelpBroker | | public static HelpBroker getHelpBroker()(Code) | | Get the application's help broker. Note that this
help is static to the whole application
|
| getHelpSet | | public static HelpSet getHelpSet()(Code) | | Get the application's help set. Note that this
help is static to the whole application
|
| getName | | public String getName()(Code) | | Return the widget's name
|
| getParentWidget | | public Widget getParentWidget()(Code) | | Return the parent widget
|
| getParentWidgetByClass | | public Widget getParentWidgetByClass(Class type)(Code) | | Return the first parent widget with is an
instance of the given class
|
| getParentWidgetByName | | public Widget getParentWidgetByName(String name)(Code) | | Return a parent widget with a given name
|
| getRealWidget | | public Component getRealWidget()(Code) | | Sometimes, a widget needs to be encapsulated - for example
inside a JPanel. This function then returns the actual widget
|
| getWidget | | public Widget getWidget(String name)(Code) | | Lookup a widget in the widget map. Note that
this could be below or above the current widget.
Search will, however, be restricted to one widget tree
|
| getWidget | | abstract public Component getWidget()(Code) | | Return the underlying swing component
|
| getWidgetInfo | | public WidgetInfo getWidgetInfo()(Code) | | Return information about the widget's available
properties. This is mostly used by the Builder
|
| hasValidators | | public boolean hasValidators()(Code) | | Return whether this widget has any validators
associated with it
|
| removeAllChildWidgets | | public void removeAllChildWidgets()(Code) | | Remove all of this widget's children from the
widget tree
|
| removeChildWidget | | public void removeChildWidget(Widget widget) throws GUIException(Code) | | Remove a child widget from the widget tree
|
| removeValidator | | public void removeValidator(Validator validator)(Code) | | Remove a validator from this widget
|
| requestFocus | | public void requestFocus()(Code) | | Request the focus
|
| revalidate | | public void revalidate() throws GUIException(Code) | | Revalidate the swing widget tree
|
| setEnabled | | public void setEnabled(boolean enabled) throws GUIException(Code) | | Set whether this widget is enabled or disabled
|
| setHelpSet | | public static void setHelpSet(HelpSet helpSet)(Code) | | Set the application's help set. Note that this
help set is static to the whole application
|
| setName | | public void setName(String newName)(Code) | | Change the widget's name. This should
only be used by the GUI Builder
|
| toString | | public String toString()(Code) | | Return a string description of this widget
|
|
|