org.apache.myfaces.tobago.component

Class UIColumn

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIColumn

org.apache.myfaces.tobago.internal.component.AbstractUIColumnBase

org.apache.myfaces.tobago.internal.component.AbstractUIColumn

org.apache.myfaces.tobago.component.UIColumn

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 UIColumn
extends AbstractUIColumn
implements Visual

Renders a UIComponent that represents a single column of data within a parent UISheet component. UIComponent class, generated from template component.stg with class ColumnTagDeclaration.

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

Method Summary

Modifier and Type	Method and Description
String	getAlign() Alignment of this column.
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	isResizable() Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
boolean	isSortable() Flag indicating whether or not this column is sortable.
void	setAlign(String align)
void	setCustomClass(CustomClass customClass)
void	setLabel(String label)
void	setMarkup(Markup markup)
void	setResizable(boolean resizable)
void	setSortable(boolean sortable)
void	setStyle(Style style)
void	setTip(String tip)

Methods inherited from class javax.faces.component.UIColumn

getFooter, getHeader, getId, setFooter, setHeader

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, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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

UIColumn

public UIColumn()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIColumn

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

isResizable

public boolean isResizable()

Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
Default: true

Overrides:

isResizable in class AbstractUIColumnBase

setResizable

public void setResizable(boolean resizable)

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

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

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

getLabel

public String getLabel()

A localized user presentable label for this component.

Specified by:

getLabel in class AbstractUIColumn

setLabel

public void setLabel(String label)

isSortable

public boolean isSortable()

Flag indicating whether or not this column is sortable. To make a column sortable the data of the sheet must be one of java.util.List or Object[].
Default: false

setSortable

public void setSortable(boolean sortable)

getAlign

public String getAlign()

Alignment of this column.

setAlign

public void setAlign(String align)