Tag definitions

The ItemsGrid component consists of two JSF component tags: itemsGrid and itemsColumn.

Tag classes:

com.businessobjects.jsf.sdk.taglib.ItemsGridTag

com.businessobjects.jsf.sdk.taglib.ItemsColumnTag

Component classes:

com.businessobjects.jsf.sdk.components.UIItemsGrid

com.businessobjects.jsf.sdk.components.UIItemsColumn

Example syntax

<boe:itemsGrid itemSource="#{enterpriseItems}" id="itemsGrid1">

    <boe:itemsColumn id="itemsColumn1" field="[SI_NAME]" />

    <boe:itemsColumn id="itemsColumn2" field="[SI_PROGID]" />

    <boe:itemsColumn id="itemsColumn3" field="[SI_DESCRIPTION]" />

</boe:itemsGrid>

Tag Attributes (itemsGrid)

The Component Class Methods column indicates the underlying set of methods that are members of the component class and govern the behavior of the attribute defined in the tag. For more information on these methods, see the JavaServer Faces Components for BusinessObjects Enterprise Java API Reference.

AttributeRequiredComponent Class MethodsDescription

action

false

getAction

setAction

Refers to a method that performs navigation processing. The results of this method are used by the navigation system to determine which page to display next.

actionListener

false

addActionListener

removeActionListener

Adds an action listener to the component. This is method binding that refers to a method on a backing bean that takes an ActionEvent as its argument.

alerts

false

getAlerts

setAlerts

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

allowDrilldown

false

isAllowDrillDown

setAllowDrillDown

Indicates whether selecting an item causes the grid to dynamically drill down into the items contents.

allowSorting

false

isAllowSorting

setAllowSorting

Indicates whether sorting on columns is enabled.

alternatingItemStyle

false

getAlternatingItemStyle

setAlternatingItemStyle

The style class for alternating items in the ItemsGrid component.

autoHandleEvents

false

isAutoHandleEvents

setAutoHandleEvents

Indicates whether the component assumes responsibility for handling its own events.

defaultRoot

false

getDefaultRoot

setDefaultRoot

The default type of the root item, or top level item.

emptyText

false

getEmptyText

setEmptyText

The text to display when the ItemGrid component is empty.

headerStyle

false

getHeaderStyle

setHeaderStyle

The style class of the heading section in the ItemsGrid component.

horizontalAlign

false

getHorizontalAlign

setHorizontalAlign

The horizontal alignment of the grid relative to the page.

id

false

getComponentID

setComponentID

The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

itemImageSize

false

getItemImageSize

setItemImageSize

The size of an item's icon or thumbnail image.

itemSource

false

getItemSource

setItemSource

The source of the item to be bound to the ItemsGrid component. This can be either an EnterpriseItem bean or an EnterpriseItems bean.

itemStyle

false

getItemStyle

setItemStyle

The style class of the items in the ItemsGrid component.

loggedOffText

false

getLoggedOffText

setLoggedOffText

The text to display when the user is logged off.

pagerStyle

false

getPagerStyle

setPagerStyle

The style class of the pager in the ItemsGrid component.

renderer

false

getRendererType

setRendererType

Name of the renderer to use if the default renderer is not used.

rootItemID

false

getRootItemID

setRootItemID

The identifier (ID or CUID) of the root item, or top level item, that can be navigated

showDrillUpLink

false

isShowDrillUpLink

setShowDrillUpLink

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

showGridLines

false

getShowGridLines

setShowGridLines

A selection that determines which grid lines are visible. None are visible by default.

showHeader

false

isShowHeader

setShowHeader

Indicates whether the header row is displayed in the ItemsGrid component.

showImages

false

getShowImages

setShowImages

Specifies how an item's image is displayed, if at all.

title

false

getTitle

setTitle

The advisory title information about markup elements generated for this component.

Tag Attributes (itemsColumn)

The Component Class Methods column indicates the underlying set of methods that are members of the component class and govern the behavior of the attribute defined in the tag. For more information on these methods, see the JavaServer Faces Components for BusinessObjects Enterprise Java API Reference.

AttributeRequiredComponent Class MethodsDescription

field

false

getField

setField

The name of the field (InfoObject property) to be displayed in the column.

headerText

false

getHeaderText

setHeaderText

The text to be displayed in the column header.

hyperlink

false

isHyperlink

setHyperlink

Indicates whether the field is a hyperlink that can be clicked.

id

false

getComponentID

setComponentID

The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

renderer

false

getRendererType

setRendererType

Name of the renderer to use if the default renderer is not used.

title

false

getTitle

setTitle

The advisory title information about markup elements generated for this component.



Business Objects
http://www.businessobjects.com/
Support services
http://www.businessobjects.com/services/support/