ColumnBase (Liferay Faces Alloy 3.0.0 API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UIColumn
    - - javax.faces.component.html.HtmlColumn
      - com.liferay.faces.alloy.component.column.ColumnBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

Column
```
@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class ColumnBase
extends javax.faces.component.html.HtmlColumn
implements com.liferay.faces.util.component.Styleable
```
Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class ColumnBase.ColumnPropertyKeys
- Nested classes/interfaces inherited from class javax.faces.component.html.HtmlColumn
  javax.faces.component.html.HtmlColumn.PropertyKeys

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`ColumnBase.ColumnPropertyKeys`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_TYPE

static String RENDERER_TYPE
- Fields inherited from class javax.faces.component.UIColumn
  COMPONENT_FAMILY
- Fields inherited from class javax.faces.component.UIComponent
  ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
- Fields inherited from interface com.liferay.faces.util.component.Styleable
  STYLE, STYLE_CLASS

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_TYPE`
`static String`	`RENDERER_TYPE`

Constructor Summary

Constructors
Constructor and Description

ColumnBase()

Constructors
Constructor and Description
`ColumnBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getExecute()` `execute` attribute description: Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle.
`Object`	`getFilterBy()` `filterBy` attribute description: When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for filtering.
`String`	`getHeaderText()` `headerText` attribute description: When alloy:column is a child of alloy:dataTable, this is the text for the column header.
`Integer`	`getOffset()` `offset` attribute description: When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a unit from 1 to 12.
`Integer`	`getOffsetWidth()` `offsetWidth` attribute description: When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a percent.
`String`	`getProcess()` `process` attribute description: Synonym for the `execute` attribute.
`String`	`getRender()` `render` attribute description: Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest.
`String`	`getSize()` `size` attribute description: When alloy:column is a child of alloy:row, this is the size of the column.
`Object`	`getSortBy()` `sortBy` attribute description: When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for sorting.
`String`	`getSortOrder()` `sortOrder` attribute description: Indicates the sort order for the column.
`Integer`	`getSpan()` `span` attribute description: When alloy:column is a child of alloy:row, this is the width of this column as a unit from 1 to 12.
`String`	`getStyle()` `style` attribute description: HTML passthrough attribute specifying the css style of the element.
`String`	`getStyleClass()` `styleClass` attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`String`	`getUpdate()` `update` attribute description: Synonym for the `render` attribute.
`Integer`	`getWidth()` `width` attribute description: When alloy:column is a child of alloy:row, this is the width of the column as a percent.
`boolean`	`isAjax()` `ajax` attribute description: When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
`void`	`setAjax(boolean ajax)` `ajax` attribute description: When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
`void`	`setExecute(String execute)` `execute` attribute description: Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle.
`void`	`setFilterBy(Object filterBy)` `filterBy` attribute description: When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for filtering.
`void`	`setHeaderText(String headerText)` `headerText` attribute description: When alloy:column is a child of alloy:dataTable, this is the text for the column header.
`void`	`setOffset(Integer offset)` `offset` attribute description: When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a unit from 1 to 12.
`void`	`setOffsetWidth(Integer offsetWidth)` `offsetWidth` attribute description: When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a percent.
`void`	`setProcess(String process)` `process` attribute description: Synonym for the `execute` attribute.
`void`	`setRender(String render)` `render` attribute description: Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest.
`void`	`setSize(String size)` `size` attribute description: When alloy:column is a child of alloy:row, this is the size of the column.
`void`	`setSortBy(Object sortBy)` `sortBy` attribute description: When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for sorting.
`void`	`setSortOrder(String sortOrder)` `sortOrder` attribute description: Indicates the sort order for the column.
`void`	`setSpan(Integer span)` `span` attribute description: When alloy:column is a child of alloy:row, this is the width of this column as a unit from 1 to 12.
`void`	`setStyle(String style)` `style` attribute description: HTML passthrough attribute specifying the css style of the element.
`void`	`setStyleClass(String styleClass)` `styleClass` attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`void`	`setUpdate(String update)` `update` attribute description: Synonym for the `render` attribute.
`void`	`setWidth(Integer width)` `width` attribute description: When alloy:column is a child of alloy:row, this is the width of the column as a percent.

Methods inherited from class javax.faces.component.html.HtmlColumn
getFooterClass, getHeaderClass, isRowHeader, setFooterClass, setHeaderClass, setRowHeader

Methods inherited from class javax.faces.component.UIColumn
getFamily, getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
    See Also:
    Constant Field Values
  - RENDERER_TYPE
```
public static final String RENDERER_TYPE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ColumnBase
```
public ColumnBase()
```
- Method Detail
  - isAjax
```
public boolean isAjax()
```
    ajax attribute description:
    
    When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
  - setAjax
```
public void setAjax(boolean ajax)
```
    ajax attribute description:
    
    When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
  - getExecute
```
public String getExecute()
```
    execute attribute description:
    
    Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: @this, @form, @all, @none, @parent. The default value is @parent (meaning, the parent alloy:dataTable).
  - setExecute
```
public void setExecute(String execute)
```
    execute attribute description:
    
    Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: @this, @form, @all, @none, @parent. The default value is @parent (meaning, the parent alloy:dataTable).
  - getFilterBy
```
public Object getFilterBy()
```
    filterBy attribute description:
    
    When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for filtering.
  - setFilterBy
```
public void setFilterBy(Object filterBy)
```
    filterBy attribute description:
    
    When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for filtering.
  - getHeaderText
```
public String getHeaderText()
```
    headerText attribute description:
    
    When alloy:column is a child of alloy:dataTable, this is the text for the column header. This attribute can be used as a convenience instead of specifying a child <f:facet name="header" /> tag.
  - setHeaderText
```
public void setHeaderText(String headerText)
```
    headerText attribute description:
    
    When alloy:column is a child of alloy:dataTable, this is the text for the column header. This attribute can be used as a convenience instead of specifying a child <f:facet name="header" /> tag.
  - getOffset
```
public Integer getOffset()
```
    offset attribute description:
    
    When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a unit from 1 to 12. This value is rendered as a CSS class as col-#{size}-offset-#{offset} (for example if offset="4", the CSS class rendered will be col-#{size}-offset-4). If both the offsetWidth and offset attributes are present, the offsetWidth attribute determines the value of the offset. Please consider using offsetWidth.
  - setOffset
```
public void setOffset(Integer offset)
```
    offset attribute description:
    
    When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a unit from 1 to 12. This value is rendered as a CSS class as col-#{size}-offset-#{offset} (for example if offset="4", the CSS class rendered will be col-#{size}-offset-4). If both the offsetWidth and offset attributes are present, the offsetWidth attribute determines the value of the offset. Please consider using offsetWidth.
  - getOffsetWidth
```
public Integer getOffsetWidth()
```
    offsetWidth attribute description:
    
    When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a percent. This value selects the offset via the formula offset = (offsetWidth/100)*12 (rounded to the nearest whole number). If both the offsetWidth and offset attributes are present, the offsetWidth attribute determines the value of the offset.
  - setOffsetWidth
```
public void setOffsetWidth(Integer offsetWidth)
```
    offsetWidth attribute description:
    
    When alloy:column is a child of alloy:row, this is the width that the column will be offset by as a percent. This value selects the offset via the formula offset = (offsetWidth/100)*12 (rounded to the nearest whole number). If both the offsetWidth and offset attributes are present, the offsetWidth attribute determines the value of the offset.
  - getProcess
```
public String getProcess()
```
    process attribute description:
    
    Synonym for the execute attribute. The default value is "@all".
  - setProcess
```
public void setProcess(String process)
```
    process attribute description:
    
    Synonym for the execute attribute. The default value is "@all".
  - getRender
```
public String getRender()
```
    render attribute description:
    
    Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: @this, @form, @all, @none, @parent. The default value is @parent (meaning, the parent alloy:dataTable).
  - setRender
```
public void setRender(String render)
```
    render attribute description:
    
    Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: @this, @form, @all, @none, @parent. The default value is @parent (meaning, the parent alloy:dataTable).
  - getSize
```
public String getSize()
```
    size attribute description:
    
    When alloy:column is a child of alloy:row, this is the size of the column. This value is rendered as a CSS class as col-#{size}-#{span} (for example if size="medium", the CSS class rendered will be col-md-#{span}). Valid values include "extra-small" (or "xs"), "small" (or "sm"), "medium" (or "md"), and "large" (or "lg").
  - setSize
```
public void setSize(String size)
```
    size attribute description:
    
    When alloy:column is a child of alloy:row, this is the size of the column. This value is rendered as a CSS class as col-#{size}-#{span} (for example if size="medium", the CSS class rendered will be col-md-#{span}). Valid values include "extra-small" (or "xs"), "small" (or "sm"), "medium" (or "md"), and "large" (or "lg").
  - getSortBy
```
public Object getSortBy()
```
    sortBy attribute description:
    
    When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for sorting.
  - setSortBy
```
public void setSortBy(Object sortBy)
```
    sortBy attribute description:
    
    When alloy:column is a child of alloy:dataTabe, this is the JavaBean property that is to be used for sorting.
  - getSortOrder
```
public String getSortOrder()
```
    sortOrder attribute description:
    
    Indicates the sort order for the column. Valid values are ascending, descending, and none.
  - setSortOrder
```
public void setSortOrder(String sortOrder)
```
    sortOrder attribute description:
    
    Indicates the sort order for the column. Valid values are ascending, descending, and none.
  - getSpan
```
public Integer getSpan()
```
    span attribute description:
    
    When alloy:column is a child of alloy:row, this is the width of this column as a unit from 1 to 12. This value is rendered as a CSS class as col-#{size}-#{span} (for example if span="4", the CSS class rendered will be col-#{size}-4). If both the width and span attributes are present, the width attribute determines the value of the span number. Please consider using width.
  - setSpan
```
public void setSpan(Integer span)
```
    span attribute description:
    
    When alloy:column is a child of alloy:row, this is the width of this column as a unit from 1 to 12. This value is rendered as a CSS class as col-#{size}-#{span} (for example if span="4", the CSS class rendered will be col-#{size}-4). If both the width and span attributes are present, the width attribute determines the value of the span number. Please consider using width.
  - getStyle
```
public String getStyle()
```
    style attribute description:
    
    HTML passthrough attribute specifying the css style of the element.
    
    Specified by:
    
    getStyle in interface com.liferay.faces.util.component.Styleable
  - setStyle
```
public void setStyle(String style)
```
    style attribute description:
    
    HTML passthrough attribute specifying the css style of the element.
    
    Specified by:
    
    setStyle in interface com.liferay.faces.util.component.Styleable
  - getStyleClass
```
public String getStyleClass()
```
    styleClass attribute description:
    
    List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
    
    Specified by:
    
    getStyleClass in interface com.liferay.faces.util.component.Styleable
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
    styleClass attribute description:
    
    List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
    
    Specified by:
    
    setStyleClass in interface com.liferay.faces.util.component.Styleable
  - getUpdate
```
public String getUpdate()
```
    update attribute description:
    
    Synonym for the render attribute. The default value is "@none".
  - setUpdate
```
public void setUpdate(String update)
```
    update attribute description:
    
    Synonym for the render attribute. The default value is "@none".
  - getWidth
```
public Integer getWidth()
```
    width attribute description:
    
    When alloy:column is a child of alloy:row, this is the width of the column as a percent. This value selects the span number via the formula span = (width/100)*12 (rounded to the nearest whole number). If both the width and span attributes are present, the width attribute determines the value of the span number.
  - setWidth
```
public void setWidth(Integer width)
```
    width attribute description:
    
    When alloy:column is a child of alloy:row, this is the width of the column as a percent. This value selects the span number via the formula span = (width/100)*12 (rounded to the nearest whole number). If both the width and span attributes are present, the width attribute determines the value of the span number.

Class ColumnBase

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlColumn

Field Summary

Fields inherited from class javax.faces.component.UIColumn

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface com.liferay.faces.util.component.Styleable

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.html.HtmlColumn

Methods inherited from class javax.faces.component.UIColumn

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_TYPE

RENDERER_TYPE

Constructor Detail

ColumnBase

Method Detail

isAjax

setAjax

getExecute

setExecute

getFilterBy

setFilterBy

getHeaderText

setHeaderText

getOffset

setOffset

getOffsetWidth

setOffsetWidth

getProcess

setProcess

getRender

setRender

getSize

setSize

getSortBy

setSortBy

getSortOrder

setSortOrder

getSpan

setSpan

getStyle

setStyle

getStyleClass

setStyleClass

getUpdate

setUpdate

getWidth

setWidth