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.component.TransientStateHolder,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 templatecomponent.stgwith classColumnTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIColumn()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TextAligngetAlign()Horizontal alignment of this column.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()StringgetLabel()A localized user presentable label for this component.MarkupgetMarkup()StringgetTip()Text value to display as tooltip.VerticalAligngetVerticalAlign()Vertical alignment of this column.booleanisResizable()Flag indicating whether or not the width of this column in a sheet is resizable, by the user.booleanisSortable()Flag indicating whether or not this column is sortable.voidrestoreState(javax.faces.context.FacesContext context, Object state)voidsetAlign(TextAlign align)voidsetCustomClass(CustomClass customClass)voidsetLabel(String label)voidsetMarkup(Markup markup)voidsetResizable(boolean resizable)voidsetSortable(boolean sortable)voidsetTip(String tip)voidsetVerticalAlign(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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjavax.faces.component.UIColumn
-
getVerticalAlign
public VerticalAlign getVerticalAlign()
Vertical alignment of this column. Possible values: {
Allowed Values:top,bottom,middle- Specified by:
getVerticalAlignin classAbstractUIColumn
-
setVerticalAlign
public void setVerticalAlign(VerticalAlign verticalAlign)
-
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:
isResizablein classAbstractUIColumnBase
-
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:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin interfaceVisual
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
getLabel
public String getLabel()
A localized user presentable label for this component.- Specified by:
getLabelin classAbstractUIColumn
-
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 ofjava.util.ListorObject[].
Default:false
-
setSortable
public void setSortable(boolean sortable)
-
getAlign
public TextAlign getAlign()
Horizontal alignment of this column. Possible values: {
Allowed Values:left,right,center,justify- Specified by:
getAlignin classAbstractUIColumn
-
setAlign
public void setAlign(TextAlign align)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIComponentBase
-
-