org.fujion.component

Class Caption

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.component.BaseLabeledComponent<BaseLabeledComponent.LabelPositionAll>

org.fujion.component.Caption

All Implemented Interfaces:

IDisable, IElementIdentifier, ILabeled

@Component(tag="caption",
           widgetClass="Caption",
           parentTag="*",
           childTag=@Component.ChildTag(value="*"),
           description="Associates a label with another component.")
public class Caption
extends BaseLabeledComponent<BaseLabeledComponent.LabelPositionAll>

Associates a label with another component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Caption.LabelAlignment Alignment of label relative to child component(s).

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

BaseLabeledComponent.ILabelPosition, BaseLabeledComponent.LabelPositionAll, BaseLabeledComponent.LabelPositionHorz, BaseLabeledComponent.LabelPositionNone

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

BaseComponent.SubComponent

Constructor Summary

Constructors

Constructor and Description
Caption()

Method Summary

Modifier and Type	Method and Description
Caption.LabelAlignment	getAlignment() Returns the alignment of the label.
String	getLabelClass() Returns the CSS class(es) associated with the label.
String	getLabelStyle() Returns the style(s) associated with the label.
BaseLabeledComponent.LabelPositionAll	getPosition() Returns the position of the label relative to its associated component.
void	setAlignment(Caption.LabelAlignment alignment) Sets the alignment of the label.
void	setLabelClass(String labelClass) Sets the CSS class(es) of the label.
void	setLabelStyle(String labelStyle) Sets the style(s) of the label.
void	setPosition(BaseLabeledComponent.LabelPositionAll position) Sets the position of the label relative to its associated component.

Methods inherited from class org.fujion.component.BaseLabeledComponent

getLabel, setLabel

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, removeClass, removeMask, removeStyle, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Caption

public Caption()

Method Detail

getPosition

@Component.PropertyGetter(value="position",
                          description="The position of the label relative to its associated component.")
public BaseLabeledComponent.LabelPositionAll getPosition()

Returns the position of the label relative to its associated component. Defaults to 'left'.

Overrides:

getPosition in class BaseLabeledComponent<BaseLabeledComponent.LabelPositionAll>

Returns:

May be one of: left, right, top, or bottom.

setPosition

@Component.PropertySetter(value="position",
                          defaultValue="left",
                          description="The position of the label relative to its associated component.")
public void setPosition(BaseLabeledComponent.LabelPositionAll position)

Sets the position of the label relative to its associated component.

Overrides:

setPosition in class BaseLabeledComponent<BaseLabeledComponent.LabelPositionAll>

Parameters:

position - May be one of: left, right, top, or bottom.

getAlignment

@Component.PropertyGetter(value="alignment",
                          description="The alignment of the label.")
public Caption.LabelAlignment getAlignment()

Returns the alignment of the label. Defaults to 'start'.

Returns:

May be one of start, center, end.

setAlignment

@Component.PropertySetter(value="alignment",
                          defaultValue="start",
                          description="The alignment of the label.")
public void setAlignment(Caption.LabelAlignment alignment)

Sets the alignment of the label.

Parameters:

alignment - May be one of: start, center, end.

getLabelStyle

@Component.PropertyGetter(value="labelStyle",
                          description="The CSS style(s) associated with the label.")
public String getLabelStyle()

Returns the style(s) associated with the label.

Returns:

The label style(s).

setLabelStyle

@Component.PropertySetter(value="labelStyle",
                          description="The CSS style(s) associated with the label.")
public void setLabelStyle(String labelStyle)

Sets the style(s) of the label.

Parameters:

labelStyle - The label style(s).

getLabelClass

@Component.PropertyGetter(value="labelClass",
                          description="The CSS class(es) associated with the label.")
public String getLabelClass()

Returns the CSS class(es) associated with the label.

Returns:

The label CSS class(es).

setLabelClass

@Component.PropertySetter(value="labelClass",
                          defaultValue="label-default",
                          description="The CSS class(es) associated with the label.")
public void setLabelClass(String labelClass)

Sets the CSS class(es) of the label.

Parameters:

labelClass - The label CSS class(es).