com.infragistics.faces.grid.component
Class Column

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIColumn
              com.infragistics.faces.grid.component.Column

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlColumn

public class Column

extends javax.faces.component.UIColumn

The Column component represents a column inside the GridView component. It provides the following functionalities:

Automatic Sorting (Built-in AJAX Support)
To enable automatic sorting, simply specify the sortBy criteria by calling the method @link #setSortBy(String)

Facets

The following facets can be nested inside this component:

Facet Name	Description
header	Specifies column header
footer	Specifies the grid footer

Tag

1) Declare the taglib in the JSP page:
<%@ taglib prefix="ig" uri="http://www.infragistics.com/faces/netadvantage" %>

2) Use the tag as follow:

 <ig:column
	binding = EL expression
	id = String
	sortBy = sortBy criteria
 >
	<-- Nested Component Tags -->
	<one or more UIComponent tag to display in the column ... />

	<-- Nested Facets - Optional -->
 	<f:facet name="footer">
		<a ui component ... />
 	</f:facet>
 	<f:facet name="header">
		<a ui component ... />
 	</f:facet>

 </ig:column>
 

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	FACET_MASTER_DETAIL
static java.lang.String	RENDERER_TYPE

Constructor Summary

Column()

Method Summary

java.lang.String	getFamily()
javax.faces.component.UIComponent	getMasterDetail() Returns the component displayed as the detail in a master-detail relationship
java.lang.String	getSortBy() Gets the sort expresssion that is used to control sorting.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setMasterDetail(javax.faces.component.UIComponent masterDetail) Sets the component displayed as the detail in a master-detail relationship
void	setSortBy(java.lang.String sortBy)

Methods inherited from class javax.faces.component.UIColumn

getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE

FACET_MASTER_DETAIL

public static final java.lang.String FACET_MASTER_DETAIL

See Also:

Constant Field Values

Constructor Detail

Column

public Column()

Method Detail

getMasterDetail

public javax.faces.component.UIComponent getMasterDetail()

Returns the component displayed as the detail in a master-detail relationship

Returns:

a UIComponent

setMasterDetail

public void setMasterDetail(javax.faces.component.UIComponent masterDetail)

Sets the component displayed as the detail in a master-detail relationship

Parameters:

masterDetail -

getFamily

public java.lang.String getFamily()

getSortBy

public java.lang.String getSortBy()

Gets the sort expresssion that is used to control sorting. If the data source is a list of JavaBeans, then the sort expression should match a property of the bean.

Returns:

Returns the sortBy.

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

setSortBy

public void setSortBy(java.lang.String sortBy)

Parameters:

sortBy - The sortBy to set.