The Path
component allows you to create a visual, "breadcrumb trail" representation of the path from a selected item, such as a folder or category, to its root item. For example, you may wish to use this component when the user is drilling down into folders and subfolders to find a report to view. In this example, the path can be visually displayed and updated as the user navigates down the path, showing how the root folder leads to the first subfolder which leads to the second subfolder, and so on until the report is reached.
rootItemID
and rootText
are the two key attributes that determine the first node in the path. Set the rootItemID
attribute to the identifier of the item that will be displayed as the root (first) item in the path. This value this attribute is set to will create an upper limit on where the user can navigate to within the hierarchy of Crystal Enterprise items. The actual text representing this top item in the path can be customized using the rootText
attribute.
Use the repeatDirection
attribute to specify whether to display the path to the user in a leftrepeatDirection
attribute must be set to fields of the com.businessobjects.jsf.sdk.properties.RepeatDirection
class.Use the separatorText
attribute to specify which characters to use to separate the items in the path. For example, you may wish to construct an arrow ("->") to represent the path leading from one element to the next. By default, this attribute is set to the greatershowSelectedItem
attribute can be set to show or hide the selected item as the last element in the path. By default, this attribute is set to true
. If set to false
, the parent item of the selected item is shown as the last element in the path.
In addition to the general attributes of the component, the showImages
attribute accesses the ImagesProps
class that contains further properties:
showImages
attribute
The showImages
attribute accesses instances of the ImagesProps
class, which contains properties that specify how images related to the items in a path are displayed. For each item in the path to show an associated image, the visible
property must be set to true
. By default, it is set to false
. The homeUrl
property allows you to specify, at design time, the image to be displayed with the first, or root item. This is the left most item when the repeatDirection
attribute is set to horizontal, and the top item when the repeatDirection
attribute is set to vertical. Images for the other items in the path are retrieved from Crystal Enterprise automatically.
Note: For more information on property classes, see How do I use property classes in combination with JavaServer Faces Components for Crystal Enterprise?
To customize the appearance of the Path
component, set the style attributes of the different parts of the component.
To enable the automatic event handling capabilities of the Path
component, set the autoHandleEvents
attribute to true
. When set to true
, this attribute implements default behavior on action events that are triggered when the user interacts with the component. For example:
Event | Default Behavior |
---|---|
When an item in the component is clicked, the data bound |
If the autoHandleEvents
attribute is set to false
, this event will not be handled automatically. If you set autoHandleEvents
to false
, you may write your own event handler.
The Path
component supports data binding to an EnterpriseItem
bean or an EnterpriseItems
bean. These beans provide the source for the item or items to display in the Path
component. Use the itemSource
attribute to bind the component to the desired bean.
Business Objects http://www.businessobjects.com/ Support services http://www.businessobjects.com/services/support/ |