org.fujion.component

Class BaseUIComponent

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

All Implemented Interfaces:

IDisable, IElementIdentifier, IClientTransform, IAttributeMap<String,Object>

Direct Known Subclasses:

BaseInputComponent, BaseLabeledComponent, Columns, Div, Grid, Groupbox, Html, Iframe, Image, Import, Listbox, Menuseparator, MessagePane, MessageWindow, Pane, Paneview, Radiogroup, Row, Rows, Slider, Span, Tabview, Toolbar, Treeview, Upload, Window

public abstract class BaseUIComponent
extends BaseComponent
implements IDisable

The base class from which all UI components derive.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
BaseUIComponent()

Method Summary

Modifier and Type	Method and Description
protected void	_syncClasses(String oldClasses) Synchronize class settings with the client.
protected void	_syncStyles(String oldStyles) Synchronizes style properties with stored styles and with the client.
void	addClass(String value) Adds one or more classes to existing classes.
void	addMask() Creates a shaded mask over the component, effectively preventing direct user interaction.
void	addMask(String label) Creates a shaded mask over the component, effectively preventing direct user interaction.
void	addMask(String label, Popup popup) Creates a shaded mask over the component, effectively preventing direct user interaction.
String	addStyle(String name, String value) Adds a style to existing styles.
void	addStyles(String styles) Adds styles specified as a string.
protected void	afterRemoveChild(BaseComponent child) If the child being removed is the popup, set the popup to null.
void	focus() Sets the input focus to this component.
String	getBalloon() Returns the balloon text to be displayed adjacent to the component.
String	getClasses() Returns the CSS classes set for this component.
Popup	getContext() Returns the popup component that will appear when right-clicking on this component.
String	getCss() Returns the CSS specifier for this component.
String	getDragid() Returns a space-delimited list of drag id's associated with this component.
String	getDropid() Returns a space-delimited list of drop id's associated with this component.
BaseUIComponent	getFirstVisibleChild(boolean recurse) Returns the first visible child, if any.
<T extends BaseUIComponent> T	getFirstVisibleChild(Class<T> clazz, boolean recurse) Returns the first visible child of a given class, if any.
String	getFlex() Returns the flex setting.
String	getHeight() Returns the height.
String	getHint() Returns the popup text to be displayed when hovering over this component.
String	getKeycapture() Returns the list of key codes to be captured.
Popup	getPopup() Returns the popup component that will appear when hovering over this component.
String	getStyle(String name) Returns the value of the named style.
String	getStyles() Returns the styles set for this component.
int	getTabindex() Returns the tab index for the component.
String	getWidth() Returns the width.
void	hide() Hides the component - a shortcut for setVisible(false).
boolean	isDisabled() Returns true if disabled.
boolean	isVisible() Returns the visibility state of the component.
protected void	onDestroyTracked(BaseComponent comp) Remove popup reference when it is destroyed.
void	print() Print this element with default options.
void	print(PrintOptions options) Print this element with the specified options.
void	removeClass(String value) Removes one or more classes from existing classes.
void	removeMask() Removes the mask, if present.
String	removeStyle(String name) Removes a style.
void	reportSize() Causes the component to report its current dimensions and relative position via a resize event.
void	scrollIntoView() Ensures that this component is visible within the view port by scrolling if necessary.
void	setBalloon(String balloon) Sets the balloon text to be displayed adjacent to the component.
void	setClasses(String classes) Sets the CSS classes for this component, replacing any existing classes.
void	setContext(Popup context) Sets the popup component that will appear when right-clicking on this component.
void	setCss(String css) Sets the CSS specifier for this component.
void	setDisabled(boolean disabled) Sets the disabled state.
void	setDragid(String dragid) Sets the drag id(s) to be associated with this component.
void	setDropid(String dropid) Sets the drag id(s) to be associated with this component.
void	setFlex(String flex) Sets the flex setting.
void	setFocus(boolean focus) Sets/removes the input focus to/from this component.
void	setHeight(String height) Sets the height.
void	setHint(String hint) Sets the popup text to be displayed when hovering over this component.
void	setKeycapture(String keycapture) Sets the list of key codes to be captured.
void	setPopup(Popup popup) Sets the popup component that will appear when hovering over this component.
void	setStyles(String styles) Sets the styles for this component, replacing any existing styles.
void	setTabindex(int tabindex) Sets the tab index for the component.
void	setVisible(boolean visible) Sets the visibility state of the component.
void	setWidth(String width) Sets the width.
void	show() Shows the component - a shortcut for setVisible(true).
void	toggleClass(String yesValue, String noValue, boolean condition) Toggles the presence of two mutually exclusive classes based on a condition.

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, detachChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getLastController, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, swapTrackedComponents, sync, toString, trackComponent, trimify, untrackComponent, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

BaseUIComponent

public BaseUIComponent()

Method Detail

addMask

public void addMask()

Creates a shaded mask over the component, effectively preventing direct user interaction.

addMask

public void addMask(String label)

Creates a shaded mask over the component, effectively preventing direct user interaction.

Parameters:

label - Text to display in the center of the mask.

addMask

public void addMask(String label,
                    Popup popup)

Creates a shaded mask over the component, effectively preventing direct user interaction.

Parameters:

label - Text to display in the center of the mask.

popup - Popup to display when right-clicking on the mask.

removeMask

public void removeMask()

Removes the mask, if present.

getStyles

@Component.PropertyGetter(value="style",
                          description="The active CSS styles for this component.")
public String getStyles()

Returns the styles set for this component.

Returns:

The styles set for this component.

setStyles

@Component.PropertySetter(value="style",
                          description="The active CSS styles for this component.")
public void setStyles(String styles)

Sets the styles for this component, replacing any existing styles.

Parameters:

styles - Styles to set, represented as a string in the same format as the HTML style attribute.

_syncStyles

protected void _syncStyles(String oldStyles)

Synchronizes style properties with stored styles and with the client.

Parameters:

oldStyles - Previous styles value.

getStyle

public String getStyle(String name)

Returns the value of the named style.

Parameters:

name - The style name (e.g., "color").

Returns:

The value of the style, or null if no value set for the style.

addStyle

public String addStyle(String name,
                       String value)

Adds a style to existing styles. If that style already exists, it will be overwritten.

Parameters:

name - The style name (e.g., "color").

value - The style value.

Returns:

The previous value of the style, or null if none.

addStyles

public void addStyles(String styles)

Adds styles specified as a string.

Parameters:

styles - Styles to add, represented as a string in the same format as the HTML style attribute.

removeStyle

public String removeStyle(String name)

Removes a style.

Parameters:

name - The style name (e.g., "color").

Returns:

The value of the removed style, or null if none.

getClasses

@Component.PropertyGetter(value="class",
                          description="Space-delimited list of CSS classes.")
public String getClasses()

Returns the CSS classes set for this component.

Returns:

Space-delimited list of CSS classes.

setClasses

public void setClasses(String classes)

Sets the CSS classes for this component, replacing any existing classes.

Parameters:

classes - Space-delimited list of CSS classes. Extended syntax is supported (see CssClasses);

_syncClasses

protected void _syncClasses(String oldClasses)

Synchronize class settings with the client.

Parameters:

oldClasses - Previous value for classes.

addClass

@Component.PropertySetter(value="class",
                          description="Space-delimited list of CSS classes.")
public void addClass(String value)

Adds one or more classes to existing classes.

Parameters:

value - Space-delimited list of CSS classes. Extended syntax is supported (see CssClasses);

removeClass

public void removeClass(String value)

Removes one or more classes from existing classes.

Parameters:

value - Space-delimited list of CSS classes. Extended syntax is supported (see CssClasses);

toggleClass

public void toggleClass(String yesValue,
                        String noValue,
                        boolean condition)

Toggles the presence of two mutually exclusive classes based on a condition. Extended syntax is supported for each of the class specifiers (see CssClasses)

Parameters:

yesValue - Classes to be added if the condition is true, or removed if false.

noValue - Classes to be added if the condition is false, or removed if true.

condition - The condition value.

hide

public void hide()

Hides the component - a shortcut for setVisible(false).

show

public void show()

Shows the component - a shortcut for setVisible(true).

getHeight

@Component.PropertyGetter(value="height",
                          description="The component\'s height.")
public String getHeight()

Returns the height. This is synchronized with the height style setting.

Returns:

The height.

setHeight

@Component.PropertySetter(value="height",
                          description="The component\'s height.")
public void setHeight(String height)

Sets the height. This is synchronized with the height style setting.

Parameters:

height - The height.

getWidth

@Component.PropertyGetter(value="width",
                          description="The component\'s width.")
public String getWidth()

Returns the width. This is synchronized with the width style setting.

Returns:

The width.

setWidth

@Component.PropertySetter(value="width",
                          description="The component\'s width.")
public void setWidth(String width)

Sets the width. This is synchronized with the width style setting.

Parameters:

width - The width.

getFlex

@Component.PropertyGetter(value="flex",
                          description="The component\'s flex style setting.")
public String getFlex()

Returns the flex setting. This is synchronized with the flex style setting.

Returns:

The flex setting.

setFlex

@Component.PropertySetter(value="flex",
                          description="The component\'s flex style setting.")
public void setFlex(String flex)

Sets the flex setting. This is synchronized with the flex style setting.

Parameters:

flex - The flex setting.

setFocus

@Component.PropertySetter(value="focus",
                          defaultValue="false",
                          defer=true,
                          description="Sets or removes focus for this component.")
public void setFocus(boolean focus)

Sets/removes the input focus to/from this component. If the component cannot receive the input focus, the request is ignored.

Parameters:

focus - If true, the component receives the input focus if possible. If false and the component currently has the input focus, the focus is relinquished.

focus

public void focus()

Sets the input focus to this component. If the component cannot receive the input focus, the request is ignored. This is a shortcut for setFocus(true).

getCss

@Component.PropertyGetter(value="css",
                          description="The CSS specifier for this component.")
public String getCss()

Returns the CSS specifier for this component. This is similar to an embedded style sheet, but is associated with this component and is added to or removed from the client as this component is added or removed. Moreover, EL expressions can be used in the selector to reference this component or one of its subcomponents by their id. For example,

      ##{id}>.inline{font-style:italic; background: white}
 

Returns:

The CSS specifier.

setCss

@Component.PropertySetter(value="css",
                          description="The CSS specifier for this component.")
public void setCss(String css)

Sets the CSS specifier for this component. This is similar to an embedded style sheet, but is associated with this component and is added to or removed from the client as this component is added or removed. Moreover, EL expressions can be used in the selector to reference this component or one of its subcomponents by their id. For example,

      ##{id}>.inline{font-style:italic; background: white}
 

Parameters:

css - The CSS specifier.

reportSize

public void reportSize()

Causes the component to report its current dimensions and relative position via a resize event.

getHint

@Component.PropertyGetter(value="hint",
                          description="The popup text to be displayed when hovering over this component.")
public String getHint()

Returns the popup text to be displayed when hovering over this component.

Returns:

The hint text.

setHint

@Component.PropertySetter(value="hint",
                          description="The popup text to be displayed when hovering over this component.")
public void setHint(String hint)

Sets the popup text to be displayed when hovering over this component.

Parameters:

hint - The hint text.

getBalloon

@Component.PropertyGetter(value="balloon",
                          description="The balloon text to be displayed adjacent to the component.")
public String getBalloon()

Returns the balloon text to be displayed adjacent to the component.

Returns:

The balloon text.

setBalloon

@Component.PropertySetter(value="balloon",
                          description="The balloon text to be displayed adjacent to the component.")
public void setBalloon(String balloon)

Sets the balloon text to be displayed adjacent to the component.

Parameters:

balloon - The balloon text.

isDisabled

@Component.PropertyGetter(value="disabled",
                          description="True if the component is disabled.")
public boolean isDisabled()

Description copied from interface: IDisable

Returns true if disabled.

Specified by:

isDisabled in interface IDisable

Returns:

True if disabled.

setDisabled

@Component.PropertySetter(value="disabled",
                          defaultValue="false",
                          description="True if the component is disabled.")
public void setDisabled(boolean disabled)

Description copied from interface: IDisable

Sets the disabled state.

Specified by:

setDisabled in interface IDisable

Parameters:

disabled - The new disabled state.

isVisible

@Component.PropertyGetter(value="visible",
                          description="The visibility state of the component.")
public boolean isVisible()

Returns the visibility state of the component.

Returns:

The visibility state of the component.

setVisible

@Component.PropertySetter(value="visible",
                          defaultValue="true",
                          description="The visibility state of the component.")
public void setVisible(boolean visible)

Sets the visibility state of the component.

Parameters:

visible - The visibility state of the component.

getTabindex

@Component.PropertyGetter(value="tabindex",
                          description="The tab index for the component.")
public int getTabindex()

Returns the tab index for the component.

Returns:

The tab index.

setTabindex

@Component.PropertySetter(value="tabindex",
                          defaultValue="0",
                          description="The tab index for the component.")
public void setTabindex(int tabindex)

Sets the tab index for the component.

Parameters:

tabindex - The tab index.

getDragid

@Component.PropertyGetter(value="dragid",
                          description="A space-delimited list of drag id\'s associated with this component.")
public String getDragid()

Returns a space-delimited list of drag id's associated with this component. A non-empty value enables dragging of the component. A dragged component may be dropped upon a target component whose drop id(s) matches at least one of the dragged component's drag id's. A drag id value of "*" will match any drop id.

Returns:

The drag id(s).

setDragid

@Component.PropertySetter(value="dragid",
                          description="A space-delimited list of drag id\'s associated with this component.")
public void setDragid(String dragid)

Sets the drag id(s) to be associated with this component.

Parameters:

dragid - A space-delimited list of drag id's to be associated with this component. A non-empty value enables dragging of the component. A dragged component may be dropped upon a target component whose drop id(s) matches at least one of the drag id's. A drag id value of "*" will match any drop id.

getDropid

@Component.PropertyGetter(value="dropid",
                          description="A space-delimited list of drop id\'s associated with this component.")
public String getDropid()

Returns a space-delimited list of drop id's associated with this component. A non-empty value enables this component to act as a drop target. A dragged component may be dropped upon a target component whose drop id(s) matches at least one of the dragged component's drag id's. A drop id value of "*" will match any drag id.

Returns:

The drag id(s).

setDropid

@Component.PropertySetter(value="dropid",
                          description="A space-delimited list of drop id\'s associated with this component.")
public void setDropid(String dropid)

Sets the drag id(s) to be associated with this component.

Parameters:

dropid - A space-delimited list of drop id's to be associated with this component. A non-empty value enables this component to act as a drop target. A dragged component may be dropped upon a target component whose drop id(s) matches at least one of the dragged component's drag id's. A drop id value of "*" will match any drag id.

getContext

@Component.PropertyGetter(value="context",
                          description="The popup component that will appear when right-clicking on this component.")
public Popup getContext()

Returns the popup component that will appear when right-clicking on this component.

Returns:

The popup component that will appear when right-clicking on this component.

setContext

@Component.PropertySetter(value="context",
                          defer=true,
                          description="The popup component that will appear when right-clicking on this component.")
public void setContext(Popup context)

Sets the popup component that will appear when right-clicking on this component.

Parameters:

context - The popup component that will appear when right-clicking on this component.

getPopup

@Component.PropertyGetter(value="popup",
                          description="The popup component that will appear when hovering over this component.")
public Popup getPopup()

Returns the popup component that will appear when hovering over this component.

Returns:

The popup component that will appear when hovering over this component.

setPopup

@Component.PropertySetter(value="popup",
                          defer=true,
                          description="The popup component that will appear when hovering over this component.")
public void setPopup(Popup popup)

Sets the popup component that will appear when hovering over this component.

Parameters:

popup - The popup component that will appear when hovering over this component.

afterRemoveChild

protected void afterRemoveChild(BaseComponent child)

If the child being removed is the popup, set the popup to null.

Overrides:

afterRemoveChild in class BaseComponent

Parameters:

child - The removed child.

See Also:

BaseComponent.afterRemoveChild(org.fujion.component.BaseComponent)

getKeycapture

@Component.PropertyGetter(value="keycapture",
                          description="The list of key codes to be captured.")
public String getKeycapture()

Returns the list of key codes to be captured. When a key in this list is typed, a "keycapture" event will be sent to this component.

Returns:

List of key codes to be captured (see KeyCode.normalizeKeyCapture(java.lang.String) for formatting details).

setKeycapture

@Component.PropertySetter(value="keycapture",
                          description="The list of key codes to be captured.")
public void setKeycapture(String keycapture)

Sets the list of key codes to be captured. When a key in this list is typed, a "keycapture" event will be sent to this component.

Parameters:

keycapture - List of key codes to be captured (see KeyCode.normalizeKeyCapture(java.lang.String) for formatting details).

scrollIntoView

public void scrollIntoView()

Ensures that this component is visible within the view port by scrolling if necessary.

getFirstVisibleChild

public BaseUIComponent getFirstVisibleChild(boolean recurse)

Returns the first visible child, if any.

Parameters:

recurse - If true, all descendant levels are also searched using a breadth first strategy.

Returns:

The first visible child encountered, or null if not found.

getFirstVisibleChild

public <T extends BaseUIComponent> T getFirstVisibleChild(Class<T> clazz,
                                                          boolean recurse)

Returns the first visible child of a given class, if any.

Type Parameters:

T - The child class.

Parameters:

clazz - The child class to consider.

recurse - If true, all descendant levels are also searched using a breadth first strategy.

Returns:

The first visible child encountered, or null if not found.

onDestroyTracked

protected void onDestroyTracked(BaseComponent comp)

Remove popup reference when it is destroyed.

Overrides:

onDestroyTracked in class BaseComponent

Parameters:

comp - The tracked component.

See Also:

BaseComponent.onDestroyTracked(org.fujion.component.BaseComponent)

print

public void print()

Print this element with default options.

print

public void print(PrintOptions options)

Print this element with the specified options.

Parameters:

options - Print options.