org.apache.myfaces.tobago.component
Class UIColumn

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIColumn
              extended by org.apache.myfaces.tobago.internal.component.AbstractUIColumn
                  extended by org.apache.myfaces.tobago.component.UIColumn
All Implemented Interfaces:
javax.faces.component.StateHolder, SupportsMarkup, Configurable, LayoutBox

public class UIColumn
extends AbstractUIColumn
implements SupportsMarkup

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


Field Summary
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIColumn
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UIColumn()
           
 
Method Summary
 String getAlign()
          Alignment of this column.
 Measure getBorderBottom()
          This attribute is for internal use only.
 Measure getBorderLeft()
          This attribute is for internal use only.
 Measure getBorderRight()
          This attribute is for internal use only.
 Measure getBorderTop()
          This attribute is for internal use only.
 Markup getCurrentMarkup()
           
 String getLabel()
          Text value to display as label.
 Markup getMarkup()
           
 Measure getPaddingBottom()
          This attribute is for internal use only.
 Measure getPaddingLeft()
          This attribute is for internal use only.
 Measure getPaddingRight()
          This attribute is for internal use only.
 Measure getPaddingTop()
          This attribute is for internal use only.
 String getTip()
          Text value to display as tooltip.
 String getWidth()
          The layout token for this column.
 boolean isOverflowX()
          This attribute is for internal use only.
 boolean isOverflowY()
          This attribute is for internal use only.
 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 restoreState(javax.faces.context.FacesContext context, Object componentState)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setAlign(String align)
           
 void setBorderBottom(Measure borderBottom)
           
 void setBorderLeft(Measure borderLeft)
           
 void setBorderRight(Measure borderRight)
           
 void setBorderTop(Measure borderTop)
           
 void setCurrentMarkup(Markup currentMarkup)
           
 void setLabel(String label)
           
 void setMarkup(Markup markup)
           
 void setOverflowX(boolean overflowX)
           
 void setOverflowY(boolean overflowY)
           
 void setPaddingBottom(Measure paddingBottom)
           
 void setPaddingLeft(Measure paddingLeft)
           
 void setPaddingRight(Measure paddingRight)
           
 void setPaddingTop(Measure paddingTop)
           
 void setResizable(boolean resizable)
           
 void setSortable(boolean sortable)
           
 void setTip(String tip)
           
 void setWidth(String width)
           
 
Methods inherited from class javax.faces.component.UIColumn
getFamily, getFooter, getHeader, getId, setFooter, setHeader
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
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.config.Configurable
getRendererType
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UIColumn

public UIColumn()
Method Detail

getMarkup

public Markup getMarkup()
Specified by:
getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)
Specified by:
setMarkup in interface SupportsMarkup

getPaddingTop

public Measure getPaddingTop()
This attribute is for internal use only.

Specified by:
getPaddingTop in interface LayoutBox

setPaddingTop

public void setPaddingTop(Measure paddingTop)
Specified by:
setPaddingTop in interface LayoutBox

getWidth

public String getWidth()
The layout token for this column. Allowd layout tokens ('*', '<x>*', '<x>px' or '<x>%'). Where '*' is equvalent to '1*'.

Specified by:
getWidth in class AbstractUIColumn

setWidth

public void setWidth(String width)

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)

getLabel

public String getLabel()
Text value to display as label. If text contains an underscore the next character is used as accesskey.


setLabel

public void setLabel(String label)

getBorderBottom

public Measure getBorderBottom()
This attribute is for internal use only.

Specified by:
getBorderBottom in interface LayoutBox

setBorderBottom

public void setBorderBottom(Measure borderBottom)
Specified by:
setBorderBottom in interface LayoutBox

getBorderLeft

public Measure getBorderLeft()
This attribute is for internal use only.

Specified by:
getBorderLeft in interface LayoutBox

setBorderLeft

public void setBorderLeft(Measure borderLeft)
Specified by:
setBorderLeft in interface LayoutBox

getTip

public String getTip()
Text value to display as tooltip.


setTip

public void setTip(String tip)

getPaddingLeft

public Measure getPaddingLeft()
This attribute is for internal use only.

Specified by:
getPaddingLeft in interface LayoutBox

setPaddingLeft

public void setPaddingLeft(Measure paddingLeft)
Specified by:
setPaddingLeft in interface LayoutBox

getPaddingRight

public Measure getPaddingRight()
This attribute is for internal use only.

Specified by:
getPaddingRight in interface LayoutBox

setPaddingRight

public void setPaddingRight(Measure paddingRight)
Specified by:
setPaddingRight in interface LayoutBox

getBorderTop

public Measure getBorderTop()
This attribute is for internal use only.

Specified by:
getBorderTop in interface LayoutBox

setBorderTop

public void setBorderTop(Measure borderTop)
Specified by:
setBorderTop in interface LayoutBox

getCurrentMarkup

public Markup getCurrentMarkup()
Specified by:
getCurrentMarkup in interface SupportsMarkup
Specified by:
getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)
Specified by:
setCurrentMarkup in interface SupportsMarkup

isOverflowX

public boolean isOverflowX()
This attribute is for internal use only.


setOverflowX

public void setOverflowX(boolean overflowX)

isResizable

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


setResizable

public void setResizable(boolean resizable)

isOverflowY

public boolean isOverflowY()
This attribute is for internal use only.


setOverflowY

public void setOverflowY(boolean overflowY)

getBorderRight

public Measure getBorderRight()
This attribute is for internal use only.

Specified by:
getBorderRight in interface LayoutBox

setBorderRight

public void setBorderRight(Measure borderRight)
Specified by:
setBorderRight in interface LayoutBox

getPaddingBottom

public Measure getPaddingBottom()
This attribute is for internal use only.

Specified by:
getPaddingBottom in interface LayoutBox

setPaddingBottom

public void setPaddingBottom(Measure paddingBottom)
Specified by:
setPaddingBottom in interface LayoutBox

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

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


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.