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.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,Visual
@Generated("component.stg")
public class UIColumn
extends AbstractUIColumn
implements javax.faces.component.behavior.ClientBehaviorHolder
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
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptiongetAlign()
Horizontal alignment of this column.Sets a CSS class in its parent, if the parent supports it.getLabel()
A localized user presentable label for this component.getTip()
Text value to display as tooltip.Vertical alignment of this column.boolean
Flag indicating whether or not the width of this column in a sheet is resizable, by the user.boolean
Flag indicating whether or not this column is sortable.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
void
setCustomClass
(CustomClass customClass) void
void
void
setResizable
(boolean resizable) void
setSortable
(boolean sortable) void
void
setVerticalAlign
(VerticalAlign verticalAlign) 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, 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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIColumn
public UIColumn()
-
-
Method Details
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UIColumn
-
getVerticalAlign
Vertical alignment of this column. Possible values: {
Allowed Values:top,bottom,middle
- Specified by:
getVerticalAlign
in classAbstractUIColumn
-
setVerticalAlign
-
getMarkup
-
setMarkup
-
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 classAbstractUIColumnBase
-
setResizable
public void setResizable(boolean resizable) -
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 interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
getTip
Text value to display as tooltip. -
setTip
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabel
in classAbstractUIColumn
-
setLabel
-
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 ofjava.util.List
orObject[]
.
Default:false
-
setSortable
public void setSortable(boolean sortable) -
getAlign
Horizontal alignment of this column. Possible values: left (default), right, center, justify -
setAlign
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-