Using the Toolbar component
|
Using the Toolbar component |
|
Toolbar component (FacesToolbarImpl) implements FacesToolbar interface. It has many properties responsible for toolbar appearance and behavior. It also has its data model and selection model. Data model consists of FacesPageToolbar objects. Which in turn will consist from FacesPageHeadToolbar and FacesToolbarItem objects.
You can set these properties on JSP page into <toolbar:toolbar> tag. It may contain only <toolbar:toolbarData> and <toolbar:toolbarSelection> tags.
If you use other framework than JSP you can use setter and getter methods on FacesToolbar instance.
| • | individual properties |
Name |
Description |
id |
Id of Toolbar component |
name |
Label of the component on the HTML page |
hintText |
Toolbar's tooltip text |
| • | look and feel properties |
Name |
Description |
fontFamily |
Any valid HTML font family |
fontWeight |
Any valid HTML font weight |
fontStyle |
Any valid HTML font style |
fontColor |
Any valid HTML font color of a header |
selectedFontColor |
Any valid HTML color |
fontSize |
Any valid HTML font size |
itemFontColor |
Any valid HTML font color of an item |
bgColor |
Any valid HTML color of toolbar's page |
pageHeaderBgColor |
Any valid HTML color of toolbar's page header |
| • | appearance properties |
Name |
Description |
frameMode |
Defines whether toolbar should be rendered to a HTML frame. TRUE,FALSE; Default value : FALSE |
headerAlign |
Header alignment. LEFT,CENTER; Default value : LEFT |
verticalSize |
Whole toolbar vertical height in percents. Any numeric value without the "%" sign |
styleClass |
HTML Class of text used for toolbar page drawing |
style |
HTML Style of the text used for toolbar page drawing |
| • | images |
Name |
Description |
iconMode |
Display mode of the items. SMALL,LARGE; Default value : LARGE |
iconWidth |
Width in pixels for default Icons |
iconHeight |
Height in pixels for default Icons |
smallIconWidth |
Width in pixels for small Icons |
smallIconHeight |
Height in pixels for small Icons |
| • | behavior properties |
Name |
Description |
toolbarItemSelectedListener |
Full class handler name. Uses with the serverSideAction property. Class must implement ToolbarItemSelectedListener interface to handle client generated event. Handler method of this class will be called only if serverSideAction set to true. Fully qualified listener class name |
toolbarHeaderSelectedListener |
Uses with the serverSideAction property. Class must implement ToolbarHeaderSelectedListener interface to handle client generated event.Handler method of this class will be called only if serverSideAction set to true. Fully qualified listener class name |
userOnHeaderSelect |
User defined callback function called when any page is selected in the form of "anyFunctionName(aHeaderIndex)". If the function returns "false" the given page won't be opened. |
userOnItemSelect |
User defined callback function called when any item is selected in the form of "anyFunctionName(aHeaderIndex,anItemIndex)" |