org.apache.myfaces.tobago.component

Class UISegmentLayout

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase

org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout

org.apache.myfaces.tobago.component.UISegmentLayout

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 UISegmentLayout
extends AbstractUISegmentLayout
implements Visual

Renders a layout using a 12 columns grid. UIComponent class, generated from template component.stg with class SegmentLayoutTagDeclaration.

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
UISegmentLayout()

Method Summary

Methods

Modifier and Type	Method and Description
Markup	getCurrentMarkup()
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
ColumnPartition	getExtraSmall() TODO
String	getFamily()
ColumnPartition	getLarge() TODO
Markup	getMarkup()
ColumnPartition	getMedium() TODO
ColumnPartition	getSmall() TODO
Style	getStyle() For internal use.
Object	saveState(javax.faces.context.FacesContext context)
void	setCurrentMarkup(Markup currentMarkup)
void	setCustomClass(CustomClass customClass)
void	setExtraSmall(ColumnPartition extraSmall)
void	setLarge(ColumnPartition large)
void	setMarkup(Markup markup)
void	setMedium(ColumnPartition medium)
void	setSmall(ColumnPartition small)
void	setStyle(Style style)

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

toString

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, 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, 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

UISegmentLayout

public UISegmentLayout()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup 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

getExtraSmall

public ColumnPartition getExtraSmall()

TODO

Specified by:

getExtraSmall in class AbstractUISegmentLayout

setExtraSmall

public void setExtraSmall(ColumnPartition extraSmall)

getCurrentMarkup

public Markup getCurrentMarkup()

Specified by:

getCurrentMarkup in interface Visual

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)

Specified by:

setCurrentMarkup in interface Visual

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 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

getSmall

public ColumnPartition getSmall()

TODO

Specified by:

getSmall in class AbstractUISegmentLayout

setSmall

public void setSmall(ColumnPartition small)

getLarge

public ColumnPartition getLarge()

TODO

Specified by:

getLarge in class AbstractUISegmentLayout

setLarge

public void setLarge(ColumnPartition large)

getMedium

public ColumnPartition getMedium()

TODO

Specified by:

getMedium in class AbstractUISegmentLayout

setMedium

public void setMedium(ColumnPartition medium)

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase