com.businessobjects.jsf.sdk.components
Class UIItemsGrid

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

public class UIItemsGrid
extends UIBaseControl

A data bound component that displays the items from an EnterpriseItem or EnterpriseItems bean in a table.

See Also:
Serialized Form

Field Summary
static int DEFAULT_ICON_SIZE
          For internal use only.
static java.lang.String TYPE
          For internal use only.
 
Constructor Summary
UIItemsGrid()
           
 
Method Summary
 void decode(FacesContext context)
           For internal use only.
 AlertProps getAlerts()
           Gets an instance of the AlertProps class that determines how alert messages are displayed in the ItemsGrid component.
 java.lang.String getAlternatingItemStyle()
           Gets the style properties for alternating items in the ItemsGrid component.
 int getCellPadding()
           Gets the amount of space between the contents of a cell and the cell's border.
 int getCellSpacing()
           Gets the amount of space between cells.
 int getDefaultRoot()
           Gets the default type of the root item, or top level item, as an integer representing the type.
 java.lang.String getEmptyText()
           Gets the text to display when the items grid is empty.
 java.lang.String getFamily()
           For internal use only.
 java.lang.String getHeaderStyle()
           Gets the style properties of the heading section in the ItemsGrid component.
 int getHorizontalAlign()
           Gets the horizontal alignment of the grid relative to its container.
 int getItemImageSize()
           Gets the size of an item's icon or thumbnail image.
 IItemSource getItemSource()
           Gets the source of the item bound to the ItemsGrid component.
 java.lang.String getItemStyle()
           Gets the style properties of the items in the ItemsGrid component.
 java.lang.String getLoggedOffText()
           Gets the text to display when the user is logged off.
 PagerProps getPagerStyle()
           Gets the style properties of the paging section of the ItemsGrid component.
 java.lang.String getRootItemID()
           Gets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.
 int getShowGridLines()
           Gets a selection that determines which grid lines are visible.
 int getShowImages()
           Gets how an item's image is displayed, if at all.
 boolean isAllowDrillDown()
           Returns a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.
 boolean isAllowSorting()
           Returns a value that indicates whether sorting on columns is enabled.
 boolean isShowDrillUpLink()
           Returns a value that indicates whether to display a link that allows the user to navigate up the hierarchy of items.
 boolean isShowHeader()
           Returns a value that indicates whether the header row is displayed in the ItemsGrid component.
 void restoreState(FacesContext context, java.lang.Object state)
           For internal use only.
 java.lang.Object saveState(FacesContext context)
           For internal use only.
 void setAlerts(AlertProps alerts)
           Sets how alert messages are displayed in the ItemsGrid component.
 void setAllowDrillDown(boolean allowDrillDown)
           Sets a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.
 void setAllowSorting(boolean allowSorting)
           Sets a value that indicates whether sorting on columns is enabled.
 void setAlternatingItemStyle(java.lang.String alternatingItemStyle)
           Sets the style properties for alternating items in the ItemsGrid component.
 void setAutoHandleEvents(boolean autoHandleEvents)
           Sets a value that indicates whether the ItemsGrid component assumes responsibility for handling its own events.
 void setCellPadding(int cellPadding)
           Sets the amount of space between the contents of a cell and the cell's border.
 void setCellSpacing(int cellSpacing)
           Sets the amount of space between cells.
 void setDefaultRoot(int defaultRoot)
           Sets the default type of the root item, or top level item, as an integer representing the type.
 void setEmptyText(java.lang.String emptyText)
           Sets the text to display when the items grid is empty.
 void setHeaderStyle(java.lang.String headerStyle)
           Sets the style properties of the heading section in the ItemsGrid component.
 void setHorizontalAlign(int horizontalAlign)
           Sets the horizontal alignment of the grid relative to its container.
 void setItemImageSize(int itemImageSize)
           Sets the size of an item's icon or thumbnail image.
 void setItemSource(IItemSource value)
           Sets the source of the item to be bound to the ItemsGrid component.
 void setItemStyle(java.lang.String itemStyle)
           Sets the style properties of the items in the ItemsGrid component.
 void setLocale(java.util.Locale locale)
           Sets the locale setting used to display all text and formatting generated by the ItemsGrid component.
 void setLoggedOffText(java.lang.String loggedOffText)
           Sets the text to display when the user is logged off.
 void setPagerStyle(PagerProps pagerStyle)
           Sets the style properties of the paging section of the ItemsGrid component.
 void setRootItemID(java.lang.String rootItemID)
           Sets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.
 void setShowDrillUpLink(boolean showDrillUpLink)
           Sets whether to display a link that allows the user to navigate up the hierarchy of items.
 void setShowGridLines(int showGridLines)
           Sets a selection that determines which grid lines are visible.
 void setShowHeader(boolean showHeader)
           Sets a value that determines whether the header row is displayed in the ItemsGrid component.
 void setShowImages(int showImages)
           Sets how an item's image is displayed, if at all.
 
Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl
getLocale, getTitle, isAutoHandleEvents, isEnabled, setEnabled, 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.


DEFAULT_ICON_SIZE

public static final int DEFAULT_ICON_SIZE

For internal use only.

See Also:
Constant Field Values
Constructor Detail

UIItemsGrid

public UIItemsGrid()
Method Detail

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale setting used to display all text and formatting generated by the ItemsGrid component.

Overrides:
setLocale in class UIBaseControl
Parameters:
locale - The component's locale.

setAutoHandleEvents

public void setAutoHandleEvents(boolean autoHandleEvents)

Sets a value that indicates whether the ItemsGrid component assumes responsibility for handling its own events. Pass in true if the component will react to its own events using a built-in event handler, otherwise, set to false.

Overrides:
setAutoHandleEvents in class UIBaseControl
Parameters:
autoHandleEvents - true if the component will react to its own events using a built-in event handler, otherwise, false.

setItemSource

public void setItemSource(IItemSource value)

Sets the source of the item to be bound to the ItemsGrid component. This can be either a EnterpriseItem bean or EntepriseItems bean.

Overrides:
setItemSource in class UIBaseControl
Parameters:
value - An IItemSource object.

getItemSource

public IItemSource getItemSource()

Gets the source of the item bound to the ItemsGrid component. This is either a EnterpriseItem bean or EntepriseItems bean.

Overrides:
getItemSource in class UIBaseControl
Returns:
An IItemSource object.

getAlerts

public AlertProps getAlerts()

Gets an instance of the AlertProps class that determines how alert messages are displayed in the ItemsGrid component.

Returns:
An AlertProps object.

setAlerts

public void setAlerts(AlertProps alerts)

Sets how alert messages are displayed in the ItemsGrid component.

Parameters:
alerts - An AlertProps object that determines how alert messages are displayed.

isAllowSorting

public boolean isAllowSorting()

Returns a value that indicates whether sorting on columns is enabled.

Returns:
A boolean that indicates whether sorting on columns is enabled.

setAllowSorting

public void setAllowSorting(boolean allowSorting)

Sets a value that indicates whether sorting on columns is enabled.

Parameters:
allowSorting - true if sorting is enabled, otherwise, false.

isAllowDrillDown

public boolean isAllowDrillDown()

Returns a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.

Returns:
A boolean that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.

setAllowDrillDown

public void setAllowDrillDown(boolean allowDrillDown)

Sets a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.


getAlternatingItemStyle

public java.lang.String getAlternatingItemStyle()

Gets the style properties for alternating items in the ItemsGrid component. This setting overrides the ItemStyle property for every other row item in the items grid. This allows the grid to display two different styles of rows in alternating fashion for visual effect.

Returns:
A String that specifies the style properties.

setAlternatingItemStyle

public void setAlternatingItemStyle(java.lang.String alternatingItemStyle)

Sets the style properties for alternating items in the ItemsGrid component. This setting overrides the ItemStyle property for every other row item in the items grid. This allows the grid to display two different styles of rows in alternating fashion for visual effect.

Parameters:
alternatingItemStyle - A String that specifies the style properties.

getDefaultRoot

public int getDefaultRoot()

Gets the default type of the root item, or top level item, as an integer representing the type. See DefaultRootType for valid root types.

Returns:
An int that specifies the default root type.

setDefaultRoot

public void setDefaultRoot(int defaultRoot)

Sets the default type of the root item, or top level item, as an integer representing the type. See DefaultRootType for valid root types.

Parameters:
defaultRoot - An int that specifies the default root type.

getEmptyText

public java.lang.String getEmptyText()

Gets the text to display when the items grid is empty.

Returns:
A String that specifies the text to display when the items grid is empty.

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Sets the text to display when the items grid is empty.

Parameters:
emptyText - A String that specifies the text to display when the items grid is empty.

getLoggedOffText

public java.lang.String getLoggedOffText()

Gets the text to display when the user is logged off.

Returns:
A String that specifies the text to display when the user is logged off.

setLoggedOffText

public void setLoggedOffText(java.lang.String loggedOffText)

Sets the text to display when the user is logged off.

Parameters:
loggedOffText - A String that specifies the text to display when the user is logged off.

getHeaderStyle

public java.lang.String getHeaderStyle()

Gets the style properties of the heading section in the ItemsGrid component.

Returns:
A String that specifies the style properties of the heading section in the ItemsGrid component.

setHeaderStyle

public void setHeaderStyle(java.lang.String headerStyle)

Sets the style properties of the heading section in the ItemsGrid component.

Parameters:
headerStyle - A String that specifies the style properties of the heading section in the ItemsGrid component.

getItemStyle

public java.lang.String getItemStyle()

Gets the style properties of the items in the ItemsGrid component.

Returns:
A String that specifies the style properties of the items in the ItemsGrid component.

setItemStyle

public void setItemStyle(java.lang.String itemStyle)

Sets the style properties of the items in the ItemsGrid component.

Parameters:
itemStyle - A String that specifies the style properties of the items in the ItemsGrid component.

getItemImageSize

public int getItemImageSize()

Gets the size of an item's icon or thumbnail image.

Returns:
An int that specifies the size of an item's icon or thumbnail image.

setItemImageSize

public void setItemImageSize(int itemImageSize)

Sets the size of an item's icon or thumbnail image.

Parameters:
itemImageSize - An int that specifies the size of an item's icon or thumbnail image.

getPagerStyle

public PagerProps getPagerStyle()

Gets the style properties of the paging section of the ItemsGrid component.

Returns:
A PagerProps object that specifies the paging style properties.

setPagerStyle

public void setPagerStyle(PagerProps pagerStyle)

Sets the style properties of the paging section of the ItemsGrid component.

Parameters:
pagerStyle - A PagerProps object that specifies the paging style properties.

getRootItemID

public java.lang.String getRootItemID()

Gets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.

Returns:
A String that specifies the identifier of the root item.

setRootItemID

public void setRootItemID(java.lang.String rootItemID)

Sets the identifier (ID or CUID) of the root item, or top level item, that can be navigated to in the grid.

Parameters:
rootItemID - A String that specifies the identifier of the root item.

isShowDrillUpLink

public boolean isShowDrillUpLink()

Returns a value that indicates whether to display a link that allows the user to navigate up the hierarchy of items.

Returns:
A boolean that indicates whether to display a link that allows the user to navigate up the hierarchy of items.

setShowDrillUpLink

public void setShowDrillUpLink(boolean showDrillUpLink)

Sets whether to display a link that allows the user to navigate up the hierarchy of items.

Parameters:
showDrillUpLink - A boolean that specifies whether to display a link that allows the user to navigate up the hierarchy of items.

getShowGridLines

public int getShowGridLines()

Gets a selection that determines which grid lines are visible. None are visible by default. See GridLines for valid values.

Returns:
An int that specifies which grid lines are visible.

setShowGridLines

public void setShowGridLines(int showGridLines)

Sets a selection that determines which grid lines are visible. None are visible by default. See GridLines for valid values.

Parameters:
showGridLines - An int that specifies which grid lines are visible.

isShowHeader

public boolean isShowHeader()

Returns a value that indicates whether the header row is displayed in the ItemsGrid component.

Returns:
A boolean that indicates whether the header row is displayed in the ItemsGrid component.

setShowHeader

public void setShowHeader(boolean showHeader)

Sets a value that determines whether the header row is displayed in the ItemsGrid component.

Parameters:
showHeader - A boolean that specifies whether the header row is displayed.

getShowImages

public int getShowImages()

Gets how an item's image is displayed, if at all. See Image for valid image display options.

Returns:
An int that specifies how an item's image is displayed, if at all.

setShowImages

public void setShowImages(int showImages)

Sets how an item's image is displayed, if at all. See Image for valid image display options.

Parameters:
showImages - An int that specifies how an item's image is displayed, if at all.

getCellPadding

public int getCellPadding()

Gets the amount of space between the contents of a cell and the cell's border.

Returns:
the cell padding as an int

setCellPadding

public void setCellPadding(int cellPadding)

Sets the amount of space between the contents of a cell and the cell's border.

Parameters:
cellPadding - the cell padding as an int

getCellSpacing

public int getCellSpacing()

Gets the amount of space between cells.

Returns:
the cell spacing as an int

setCellSpacing

public void setCellSpacing(int cellSpacing)

Sets the amount of space between cells.

Parameters:
cellSpacing - the cell spacing as an int

getHorizontalAlign

public int getHorizontalAlign()

Gets the horizontal alignment of the grid relative to its container. The horizontal alignment values are specified by the HorizonalAlign enumeration.

Returns:
the horizontal alignment as an int

setHorizontalAlign

public void setHorizontalAlign(int horizontalAlign)

Sets the horizontal alignment of the grid relative to its container. The horizontal alignment values are specified by the HorizonalAlign enumeration.

Parameters:
horizontalAlign - the horizontal alignment as an int

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