org.apache.myfaces.tobago.component

Class UIBox

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase

org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel

org.apache.myfaces.tobago.internal.component.AbstractUIBox

org.apache.myfaces.tobago.component.UIBox

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual

public class UIBox
extends AbstractUIBox
implements Visual

Renders a panel with border and title. UIComponent class, generated from template component.stg with class BoxTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UIBox()

Method Summary

Modifier and Type	Method and Description
CollapseMode	getCollapsedMode() Enum indicating the mode of the collapsed state of this component.
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getFamily()
String	getLabel() A localized user presentable label for this component.
Markup	getMarkup()
Style	getStyle() For internal use.
String	getTip() Text value to display as tooltip.
boolean	isCollapsed() Indicating the collapsed state of this component.
void	setCollapsed(boolean collapsed)
void	setCollapsedMode(CollapseMode collapsedMode)
void	setCustomClass(CustomClass customClass)
void	setLabel(String label)
void	setMarkup(Markup markup)
void	setStyle(Style style)
void	setTip(String tip)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel

isNormalLifecycle, processDecodes, processState, processUpdates, processValidators, setSubmittedCollapsed

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase

encodeBegin, encodeChildren, encodeEnd

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.tobago.component.Visual

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIBox

public UIBox()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

isCollapsed

public boolean isCollapsed()

Indicating the collapsed state of this component.
Default: false

Specified by:

isCollapsed in class AbstractUICollapsiblePanel

setCollapsed

public void setCollapsed(boolean collapsed)

Specified by:

setCollapsed in class AbstractUICollapsiblePanel

getCustomClass

public CustomClass getCustomClass()

Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:

   <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
   

One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

getTip

public String getTip()

Text value to display as tooltip.

Specified by:

getTip in class AbstractUIPanelBase

setTip

public void setTip(String tip)

getLabel

public String getLabel()

A localized user presentable label for this component.

Specified by:

getLabel in class AbstractUIBox

setLabel

public void setLabel(String label)

getCollapsedMode

public CollapseMode getCollapsedMode()

Enum indicating the mode of the collapsed state of this component.
Default: none

Specified by:

getCollapsedMode in class AbstractUICollapsiblePanel

setCollapsedMode

public void setCollapsedMode(CollapseMode collapsedMode)