com.businessobjects.jsf.sdk.components
Class UIItemsColumn

java.lang.Object
  |
  +--UICommand
        |
        +--com.businessobjects.jsf.sdk.components.UIBaseControl
              |
              +--com.businessobjects.jsf.sdk.components.UIItemsColumn

public class UIItemsColumn
extends UIBaseControl

A column that appears in the ItemsGrid component.

See Also:
Serialized Form

Field Summary
static java.lang.String TYPE
          For internal use only.
 
Constructor Summary
UIItemsColumn()
           
 
Method Summary
 void decode(FacesContext context)
           For internal use only.
 int getColumnIndex()
           For internal use only.
 java.lang.String getFamily()
           For internal use only.
 java.lang.String getField()
           Gets the field used for the column data.
 java.lang.String getHeaderText()
           Gets the header text that is used for the column's label.
 IInfoObject getInfoObject()
           For internal use only.
 int getRowIndex()
           For internal use only.
 boolean isHyperlink()
           Returns a value that indicates whether each item (row) in the column is clickable as a hyperlink.
 void restoreState(FacesContext context, java.lang.Object state)
           For internal use only.
 java.lang.Object saveState(FacesContext context)
           For internal use only.
 void setColumnIndex(int columnIndex)
           For internal use only.
 void setField(java.lang.String value)
           Gets the field used for the column data.
 void setHeaderText(java.lang.String value)
           Sets the header text that is used for the column's label.
 void setHyperlink(boolean hyperlink)
           Sets a value that indicates whether each item (row) in the column is clickable as a hyperlink.
 void setInfoObject(IInfoObject value)
           For internal use only.
 void setRowIndex(int rowIndex)
           For internal use only.
 
Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl
getItemSource, getLocale, getTitle, isAutoHandleEvents, isEnabled, setAutoHandleEvents, setEnabled, setItemSource, setLocale, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static java.lang.String TYPE

For internal use only.

Constructor Detail

UIItemsColumn

public UIItemsColumn()
Method Detail

getHeaderText

public java.lang.String getHeaderText()

Gets the header text that is used for the column's label.

Returns:
A String that represents the header text that is used for the column's label.

setHeaderText

public void setHeaderText(java.lang.String value)

Sets the header text that is used for the column's label.

Parameters:
value - A String that represents the header text that is used for the column's label.

getField

public java.lang.String getField()

Gets the field used for the column data.

Returns:
A String that specifies the field used for the column data.

setField

public void setField(java.lang.String value)

Gets the field used for the column data.

Parameters:
value - A String that specifies the field to use for the column data.

isHyperlink

public boolean isHyperlink()

Returns a value that indicates whether each item (row) in the column is clickable as a hyperlink.

Returns:
true if the column items are clickable as hyperlinks, otherwise, false.

setHyperlink

public void setHyperlink(boolean hyperlink)

Sets a value that indicates whether each item (row) in the column is clickable as a hyperlink.

Parameters:
hyperlink - true to make the column items clickable as hyperlinks, otherwise, false.

setInfoObject

public void setInfoObject(IInfoObject value)

For internal use only.


getInfoObject

public IInfoObject getInfoObject()

For internal use only.


getColumnIndex

public int getColumnIndex()

For internal use only.


setColumnIndex

public void setColumnIndex(int columnIndex)

For internal use only.


getRowIndex

public int getRowIndex()

For internal use only.


setRowIndex

public void setRowIndex(int rowIndex)

For internal use only.


decode

public void decode(FacesContext context)

For internal use only.


getFamily

public java.lang.String getFamily()

For internal use only.


saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.

Overrides:
saveState in class UIBaseControl

restoreState

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

For internal use only.

Overrides:
restoreState in class UIBaseControl