|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--UICommand | +--com.businessobjects.jsf.sdk.components.UIBaseControl | +--com.businessobjects.jsf.sdk.components.UIPath
Provides the user with a visual, "breadcrumb trail" representation of the path from a selected item, such as a report, to its root item.
Field Summary | |
static java.lang.String |
TYPE
For internal use only. |
Constructor Summary | |
UIPath()
|
Method Summary | |
void |
decode(FacesContext context)
For internal use only. |
int |
getDefaultRoot()
Gets the default type of the root item, or top level item. |
java.lang.String |
getFamily()
For internal use only. |
IItemSource |
getItemSource()
Gets the source of the item bound to the Path component. |
java.lang.String |
getItemStyle()
Gets the style for the items in the grid. |
int |
getRepeatDirection()
Gets whether the path is rendered horizontally or vertically. |
java.lang.String |
getRootItemID()
Gets the identifier (ID or CUID) of the root item, or top level item, in the path. |
java.lang.String |
getRootText()
Gets the text to display for the root item, or top level item, in the Path component.
|
java.lang.String |
getSelectedItemStyle()
Gets the style for the selected item. |
java.lang.String |
getSeparatorStyle()
Gets the style of the text used to separate items within the path. |
java.lang.String |
getSeparatorText()
Gets the text used to separate items within the path. |
ImagesProps |
getShowImages()
Gets an instance of the ImagesProps class that determines how images are displayed in the Path component.
|
boolean |
isShowSelectedItem()
Returns a value that indicates whether to show the selected item in the visual path. |
void |
restoreState(FacesContext context,
java.lang.Object state)
For internal use only. |
java.lang.Object |
saveState(FacesContext context)
For internal use only. |
void |
setAutoHandleEvents(boolean autoHandleEvents)
Sets a value indicating whether the Path component assumes responsibility for handling its own events.
|
void |
setDefaultRoot(int defaultRoot)
Sets the default type of the root item, or top level item. |
void |
setItemSource(IItemSource value)
Sets the source of the item to be bound to the Path component. |
void |
setItemStyle(java.lang.String itemStyle)
Sets the style for the items in the grid. |
void |
setLocale(java.util.Locale locale)
Sets the locale setting used to display all text and formatting generated by the Path component. |
void |
setRepeatDirection(int repeatDirection)
Sets whether the path is rendered horizontally or vertically. |
void |
setRootItemID(java.lang.String rootItemID)
Sets the identifier (ID or CUID) of the root item, or top level item, in the path. |
void |
setRootText(java.lang.String rootText)
Sets the text to display for the root item, or top level item, in the Path component.
|
void |
setSelectedItemStyle(java.lang.String selectedItemStyle)
Sets the style for the selected item. |
void |
setSeparatorStyle(java.lang.String separatorStyle)
Sets the style of the text used to separate items within the path. |
void |
setSeparatorText(java.lang.String separatorText)
Sets the text used to separate items within the path. |
void |
setShowImages(ImagesProps showImages)
Sets an instance of the ImagesProps class that determines how images are displayed in the Path component.
|
void |
setShowSelectedItem(boolean showSelectedItem)
Sets whether to show the selected item in the visual path. |
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 |
public static java.lang.String TYPE
For internal use only.
Constructor Detail |
public UIPath()
Method Detail |
public void setLocale(java.util.Locale locale)
Sets the locale setting used to display all text and formatting generated by the Path component.
setLocale
in class UIBaseControl
locale
- The component's locale.public void setAutoHandleEvents(boolean autoHandleEvents)
Sets a value indicating whether the Path
component assumes responsibility for handling its own events.
Pass in true
if the control will react to its own events using a built-in event handler,
otherwise, set to false
.
setAutoHandleEvents
in class UIBaseControl
autoHandleEvents
- true
if the component will react to its own events using a built-in event handler, otherwise, false
.public int getRepeatDirection()
Gets whether the path is rendered horizontally or vertically. See RepeatDirection
for details.
int
that specifies whether the path is rendered horizontally or vertically.public void setRepeatDirection(int repeatDirection)
Sets whether the path is rendered horizontally or vertically. See RepeatDirection
for details.
repeatDirection
- An int
that specifies whether the path is rendered horizontally or vertically.public ImagesProps getShowImages()
Gets an instance of the ImagesProps
class that determines how images are displayed in the Path
component.
ImagesProps
object that determines how images are displayed in the Path
component.public void setShowImages(ImagesProps showImages)
Sets an instance of the ImagesProps
class that determines how images are displayed in the Path
component.
showImages
- An ImagesProps
object that determines how images are displayed in the Path
component.public java.lang.String getRootText()
Gets the text to display for the root item, or top level item, in the Path
component.
String
that specifies the text to display for the root item.public void setRootText(java.lang.String rootText)
Sets the text to display for the root item, or top level item, in the Path
component.
rootText
- A String
that specifies the text to display for the root item.public java.lang.String getSeparatorText()
Gets the text used to separate items within the path.
String
that specifies the text used to separate items within the path.public void setSeparatorText(java.lang.String separatorText)
Sets the text used to separate items within the path.
separatorText
- A String
that specifies the text used to separate items within the path.public java.lang.String getItemStyle()
Gets the style for the items in the grid.
String
that specifies the style for the items in the grid.public void setItemStyle(java.lang.String itemStyle)
Sets the style for the items in the grid.
itemStyle
- A String
that specifies the style for the items in the grid.public java.lang.String getSeparatorStyle()
Gets the style of the text used to separate items within the path.
String
that specifies the style of the text used to separate items within the path.public void setSeparatorStyle(java.lang.String separatorStyle)
Sets the style of the text used to separate items within the path.
separatorStyle
- A String
that specifies the style of the text used to separate items within the path.public java.lang.String getSelectedItemStyle()
Gets the style for the selected item.
String
that specifies the style for the selected item.public void setSelectedItemStyle(java.lang.String selectedItemStyle)
Sets the style for the selected item.
selectedItemStyle
- A String
that specifies the style for the selected item.public boolean isShowSelectedItem()
Returns a value that indicates whether to show the selected item in the visual path.
boolean
that indicates whether to show the selected item in the visual path.public void setShowSelectedItem(boolean showSelectedItem)
Sets whether to show the selected item in the visual path.
showSelectedItem
- A boolean
that indicates whether to show the selected item in the visual path.public java.lang.String getRootItemID()
Gets the identifier (ID or CUID) of the root item, or top level item, in the path.
String
that specifies the root item in the path.public void setRootItemID(java.lang.String rootItemID)
Sets the identifier (ID or CUID) of the root item, or top level item, in the path.
rootItemID
- A String
that specifies the root item in the path.public int getDefaultRoot()
Gets the default type of the root item, or top level item. See DefaultRootType
for valid root types.
int
that specifies the default type of the root item, or top level item.public void setDefaultRoot(int defaultRoot)
Sets the default type of the root item, or top level item. See DefaultRootType
for valid root types.
public void setItemSource(IItemSource value)
Sets the source of the item to be bound to the Path
component. This can be either a EnterpriseItem
bean or EntepriseItems
bean.
setItemSource
in class UIBaseControl
value
- An IItemSource
object.public IItemSource getItemSource()
Gets the source of the item bound to the Path
component. This is either a EnterpriseItem
bean or EntepriseItems
bean.
getItemSource
in class UIBaseControl
IItemSource
object.public void decode(FacesContext context)
For internal use only.
public java.lang.String getFamily()
For internal use only.
public java.lang.Object saveState(FacesContext context)
For internal use only.
saveState
in class UIBaseControl
public void restoreState(FacesContext context, java.lang.Object state)
For internal use only.
restoreState
in class UIBaseControl
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |