Package com.leafdigital.ui.api

The UI API provides a basic windowing interface library of widgets that can be constructed from XML.

See:
          Description

Interface Summary
BorderPanel A Panel with nine component slots - all the compass points, plus a central component.
Button Interface for buttons.
ButtonPanel A Panel that lays out buttons horizontally in the appropriate platform order.
CallbackHandler Represents callbacks for a particular object
CheckBox Interface for checkboxes.
ChoicePanel A Panel with any number of slots (all Page objects).
DecoratedPanel Provides visual decoration as a background to other components.
Dialog This interface represents the contents of a single Dialog within the system.
Dropdown Interface for combo boxes.
EditArea Interface for multi-line edit boxes.
EditBox Interface for single-line edit boxes.
EditBox.TabCompletion Handler interface to be implemented by anything that provides completion.
GroupPanel A Panel with only a single slot, named 'contents' in XML.
HorizontalPanel A Panel with any number of slots (all named 'slot' in XML).
Label Interface for wrapping (multi-line) labels
ListBox Interface for list boxes.
Page This interface represents the contents of a single Page within the system.
PageTool A tool that's based on a UI page.
Panel Represents a Panel, a component which can hold other components in various slots.
Pic Interface for images from theme.
PopupMenu Represents a popup menu with a number of items and separators.
Progress Interface for progress bars
RadioButton Interface for radio buttons.
ScrollPanel A panel with a vertical scrollbar which contains one widget.
SimpleTool A tool that's just a button.
SizeInfo JComponentWrapper-wrapped components may implement this if they need width-dependent sizing.
Spacer Interface for spacers, which don't display anything but just take up space.
SplitPanel A Panel with two component slots - 'main' and 'split'.
SupportsBaseGroup Interface for widgets that support the BaseGroup function
SupportsMacIndent Interface for widgets that support the BaseGroup function
Table Interface for tables.
TabPanel A Panel with any number of slots (all named 'tab' in XML).
TextView Interface for a scrolling text view.
TextView.ActionHandler Interface that happens when user clicks on things
TextView.MenuHandler Interface used when user right-clicks
Theme API for information held by the theme.
Tool Represents something that goes on the toolbar.
TreeBox Like listbox but contains a tree of items
TreeBox.DragSingleSelectionHandler Interface to implement if you need to know about selection and dragging
TreeBox.Handler Interface implemented by users to handle the tree
TreeBox.Item Interface implemented by users to pass on information about the tree of options.
TreeBox.MultiSelectionHandler Interface to implement if you need to know about selection & allow multiple
TreeBox.SingleSelectionHandler Interface to implement if you need to know about selection
UI Main UI singleton.
UIPrefs Preferences values for UI; which need to be accessed by the uiprefs plugin so are public.
VerticalPanel A Panel with any number of slots (all named 'slot' in XML).
Widget Interface implemented by all objects that you can add to the user interface.
WidgetOwner Interface (implemented by windows and dialogs) for the 'owner' of widgets, to be identified by string IDs.
WidgetParent Interface for any widget that contains other widgets.
Window This interface represents the contents of a single Window within the system.
 

Class Summary
Table.EditingControl Class passed as part of the onEditing callback.
 

Annotation Types Summary
UIAction Annotation used to indicate that a method is used as a UI callback from an XML file.
UICallback Indicates that method has a single parameter which is the name of a callback function in the target UI handler.
UIHandler Annotation used to indicate that an object supports callbacks associated with a particular UI XML file.
 

Package com.leafdigital.ui.api Description

The UI API provides a basic windowing interface library of widgets that can be constructed from XML. It also handles the various different types of windowing interfaces leafChat supports (single-window mode, tabbed mode, multiple-window mode).



Copyright © 2011 Samuel Marshall. All rights reserved.