|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectUICommand
com.businessobjects.jsf.sdk.components.UIBaseControl
com.businessobjects.jsf.sdk.components.UIItemsGrid
A data bound server component that displays the items from an EnterpriseItem
or EnterpriseItems
bean in a table.
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, isAutoHandleEvents, isEnabled, setEnabled |
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.
public static final int DEFAULT_ICON_SIZE
For internal use only.
Constructor Detail |
public UIItemsGrid()
Method Detail |
public void setLocale(java.util.Locale locale)
Sets the locale setting used to display all text and formatting generated by the ItemsGrid component.
setLocale
in class UIBaseControl
locale
- The component's locale.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
.
setAutoHandleEvents
in class UIBaseControl
autoHandleEvents
- true
if the component will react to its own events using a built-in event handler, otherwise, false
.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.
setItemSource
in class UIBaseControl
value
- An IItemSource
object.public IItemSource getItemSource()
Gets the source of the item bound to the ItemsGrid
component. This is either a EnterpriseItem
bean or EntepriseItems
bean.
getItemSource
in class UIBaseControl
IItemSource
object.public AlertProps getAlerts()
Gets an instance of the AlertProps
class that determines how alert messages are displayed in the ItemsGrid
component.
AlertProps
object.public void setAlerts(AlertProps alerts)
Sets how alert messages are displayed in the ItemsGrid
component.
alerts
- An AlertProps
object that determines how alert messages are displayed.public boolean isAllowSorting()
Returns a value that indicates whether sorting on columns is enabled.
boolean
that indicates whether sorting on columns is enabled.public void setAllowSorting(boolean allowSorting)
Sets a value that indicates whether sorting on columns is enabled.
allowSorting
- true
if sorting is enabled, otherwise, false
.public boolean isAllowDrillDown()
Returns a value that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.
boolean
that indicates whether selecting an item causes the grid to dynamically drill down into the items contents.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.
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.
String
that specifies the style properties.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.
alternatingItemStyle
- A String
that specifies the style properties.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.
int
that specifies the default root type.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.
defaultRoot
- An int
that specifies the default root type.public java.lang.String getEmptyText()
Gets the text to display when the items grid is empty.
String
that specifies the text to display when the items grid is empty.public void setEmptyText(java.lang.String emptyText)
Sets the text to display when the items grid is empty.
emptyText
- A String
that specifies the text to display when the items grid is empty.public java.lang.String getLoggedOffText()
Gets the text to display when the user is logged off.
String
that specifies the text to display when the user is logged off.public void setLoggedOffText(java.lang.String loggedOffText)
Sets the text to display when the user is logged off.
loggedOffText
- A String
that specifies the text to display when the user is logged off.public java.lang.String getHeaderStyle()
Gets the style properties of the heading section in the ItemsGrid
component.
String
that specifies the style properties of the heading section in the ItemsGrid
component.public void setHeaderStyle(java.lang.String headerStyle)
Sets the style properties of the heading section in the ItemsGrid
component.
headerStyle
- A String
that specifies the style properties of the heading section in the ItemsGrid
component.public java.lang.String getItemStyle()
Gets the style properties of the items in the ItemsGrid
component.
String
that specifies the style properties of the items in the ItemsGrid
component.public void setItemStyle(java.lang.String itemStyle)
Sets the style properties of the items in the ItemsGrid
component.
itemStyle
- A String
that specifies the style properties of the items in the ItemsGrid
component.public int getItemImageSize()
Gets the size of an item's icon or thumbnail image.
int
that specifies the size of an item's icon or thumbnail image.public void setItemImageSize(int itemImageSize)
Sets the size of an item's icon or thumbnail image.
itemImageSize
- An int
that specifies the size of an item's icon or thumbnail image.public PagerProps getPagerStyle()
Gets the style properties of the paging section of the ItemsGrid
component.
PagerProps
object that specifies the paging style properties.public void setPagerStyle(PagerProps pagerStyle)
Sets the style properties of the paging section of the ItemsGrid
component.
pagerStyle
- A PagerProps
object that specifies the paging style properties.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.
String
that specifies the identifier of the root item.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.
rootItemID
- A String
that specifies the identifier of the root item.public boolean isShowDrillUpLink()
Returns a value that indicates whether to display a link that allows the user to navigate up the hierarchy of items.
boolean
that indicates whether to display a link that allows the user to navigate up the hierarchy of items.public void setShowDrillUpLink(boolean showDrillUpLink)
Sets whether to display a link that allows the user to navigate up the hierarchy of items.
showDrillUpLink
- A boolean
that specifies whether to display a link that allows the user to navigate up the hierarchy of items.public int getShowGridLines()
Gets a selection that determines which grid lines are visible. None are visible by default.
See GridLines
for valid values.
int
that specifies which grid lines are visible.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.
showGridLines
- An int
that specifies which grid lines are visible.public boolean isShowHeader()
Returns a value that indicates whether the header row is displayed in the ItemsGrid
component.
boolean
that indicates whether the header row is displayed in the ItemsGrid
component.public void setShowHeader(boolean showHeader)
Sets a value that determines whether the header row is displayed in the ItemsGrid
component.
showHeader
- A boolean
that specifies whether the header row is displayed.public int getShowImages()
Gets how an item's image is displayed, if at all. See Image
for valid image display options.
int
that specifies how an item's image is displayed, if at all.public void setShowImages(int showImages)
Sets how an item's image is displayed, if at all. See Image
for valid image display options.
showImages
- An int
that specifies how an item's image is displayed, if at all.public int getCellPadding()
Gets the amount of space between the contents of a cell and the cell's border.
int
public void setCellPadding(int cellPadding)
Sets the amount of space between the contents of a cell and the cell's border.
cellPadding
- the cell padding as an int
public int getCellSpacing()
Gets the amount of space between cells.
int
public void setCellSpacing(int cellSpacing)
Sets the amount of space between cells.
cellSpacing
- the cell spacing as an int
public int getHorizontalAlign()
Gets the horizontal alignment of the grid relative to its container. The horizontal alignment values
are specified by the HorizonalAlign
enumeration.
int
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.
horizontalAlign
- the horizontal alignment as an int
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.
public void restoreState(FacesContext context, java.lang.Object state)
For internal use only.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |