com.businessobjects.jsf.sdk.components
Class UIPath

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

public class UIPath
extends UIBaseControl

Provides the user with a visual, "breadcrumb trail" representation of the path from a selected item, such as a report, to its root item.

See Also:
Serialized Form

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

TYPE

public static java.lang.String TYPE

For internal use only.

Constructor Detail

UIPath

public UIPath()
Method Detail

setLocale

public void setLocale(java.util.Locale locale)

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

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

setAutoHandleEvents

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.

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.

getRepeatDirection

public int getRepeatDirection()

Gets whether the path is rendered horizontally or vertically. See RepeatDirection for details.

Returns:
An int that specifies whether the path is rendered horizontally or vertically.

setRepeatDirection

public void setRepeatDirection(int repeatDirection)

Sets whether the path is rendered horizontally or vertically. See RepeatDirection for details.

Parameters:
repeatDirection - An int that specifies whether the path is rendered horizontally or vertically.

getShowImages

public ImagesProps getShowImages()

Gets an instance of the ImagesProps class that determines how images are displayed in the Path component.

Returns:
An ImagesProps object that determines how images are displayed in the Path component.

setShowImages

public void setShowImages(ImagesProps showImages)

Sets an instance of the ImagesProps class that determines how images are displayed in the Path component.

Parameters:
showImages - An ImagesProps object that determines how images are displayed in the Path component.

getRootText

public java.lang.String getRootText()

Gets the text to display for the root item, or top level item, in the Path component.

Returns:
A String that specifies the text to display for the root item.

setRootText

public void setRootText(java.lang.String rootText)

Sets the text to display for the root item, or top level item, in the Path component.

Parameters:
rootText - A String that specifies the text to display for the root item.

getSeparatorText

public java.lang.String getSeparatorText()

Gets the text used to separate items within the path.

Returns:
A String that specifies the text used to separate items within the path.

setSeparatorText

public void setSeparatorText(java.lang.String separatorText)

Sets the text used to separate items within the path.

Parameters:
separatorText - A String that specifies the text used to separate items within the path.

getItemStyle

public java.lang.String getItemStyle()

Gets the style for the items in the grid.

Returns:
A String that specifies the style for the items in the grid.

setItemStyle

public void setItemStyle(java.lang.String itemStyle)

Sets the style for the items in the grid.

Parameters:
itemStyle - A String that specifies the style for the items in the grid.

getSeparatorStyle

public java.lang.String getSeparatorStyle()

Gets the style of the text used to separate items within the path.

Returns:
A String that specifies the style of the text used to separate items within the path.

setSeparatorStyle

public void setSeparatorStyle(java.lang.String separatorStyle)

Sets the style of the text used to separate items within the path.

Parameters:
separatorStyle - A String that specifies the style of the text used to separate items within the path.

getSelectedItemStyle

public java.lang.String getSelectedItemStyle()

Gets the style for the selected item.

Returns:
A String that specifies the style for the selected item.

setSelectedItemStyle

public void setSelectedItemStyle(java.lang.String selectedItemStyle)

Sets the style for the selected item.

Parameters:
selectedItemStyle - A String that specifies the style for the selected item.

isShowSelectedItem

public boolean isShowSelectedItem()

Returns a value that indicates whether to show the selected item in the visual path.

Returns:
A boolean that indicates whether to show the selected item in the visual path.

setShowSelectedItem

public void setShowSelectedItem(boolean showSelectedItem)

Sets whether to show the selected item in the visual path.

Parameters:
showSelectedItem - A boolean that indicates whether to show the selected item in the visual path.

getRootItemID

public java.lang.String getRootItemID()

Gets the identifier (ID or CUID) of the root item, or top level item, in the path.

Returns:
A String that specifies the root item in the path.

setRootItemID

public void setRootItemID(java.lang.String rootItemID)

Sets the identifier (ID or CUID) of the root item, or top level item, in the path.

Parameters:
rootItemID - A String that specifies the root item in the path.

getDefaultRoot

public int getDefaultRoot()

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

Returns:
An int that specifies the default type of the root item, or top level item.

setDefaultRoot

public void setDefaultRoot(int defaultRoot)

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


setItemSource

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.

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

getItemSource

public IItemSource getItemSource()

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

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

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