|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.javatools.ui.builders.ToolBarBuilder
public final class ToolBarBuilder
A Builder of ToolBars. Tell the builder what things to put on a toolbar, then call 'build()'. The builder will build a toolbar to the given specifications which conforms to UI guidelines.
Some items have a fixed location on the toolbar: e.g. the search field, and the secondary actions drop down. Other items can either be added to the left or right hand side of the toolbar. Items are placed on the toolbar from left to right in the order in which they were given to the builder.
Constructor Summary | |
---|---|
ToolBarBuilder() |
Method Summary | |
---|---|
void |
addActions(boolean leftAligned, javax.swing.Action... actions) Add actions to the toolbar. |
void |
addComponents(boolean leftAligned, java.awt.Component... components) Add an arbitrary component to the toolbar |
void |
addDropActions(boolean leftAligned, javax.swing.Icon icon, java.lang.String tooltipText, javax.swing.Action... actions) Add an icon button to the toolbar that when pressed reveals a drop list of actions. |
void |
addDropActions(boolean leftAligned, java.lang.String text, javax.swing.Action... actions) Add a button to the toolbar that when pressed reveals a drop list of actions. |
void |
addSeparator(boolean leftAligned) Add a separator to the toolbar. |
BuiltToolBar |
build() Create and return the class containing the built UI for the specified toolbar. |
void |
setActionsSecondary(javax.swing.Action... actions) Add additional (less important) action(s) to the list. |
void |
setActionsSecondary(java.lang.String moreActionsText, javax.swing.Action... actions) Add additional (less important) action(s) to the list. |
void |
setSearch(SearchField.Style searchStyle, java.lang.String searchPrompt) Add a search control to the toolbar. |
void |
setToolBar(javax.swing.JToolBar toolBar) Set the toolbar instance used by the builder, e.g. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ToolBarBuilder()
Method Detail |
---|
public BuiltToolBar build()
public void setToolBar(javax.swing.JToolBar toolBar)
toolBar
- the custom toolbar used by the builderpublic void addActions(boolean leftAligned, javax.swing.Action... actions)
leftAligned
- if true the actions will be added to the left area of the toolbar, otherwise they'll be added to the rightactions
-public void addDropActions(boolean leftAligned, java.lang.String text, javax.swing.Action... actions)
leftAligned
- if true the actions will be added to the left area of the toolbar, otherwise they'll be added to the rightactions
-text
- the text of the drop button (may include mnemonic &)public void addDropActions(boolean leftAligned, javax.swing.Icon icon, java.lang.String tooltipText, javax.swing.Action... actions)
leftAligned
- if true the actions will be added to the left area of the toolbar, otherwise they'll be added to the rightactions
-icon
- the icon for the drop buttontooltipText
- tooltip text for the drop buttonpublic void addComponents(boolean leftAligned, java.awt.Component... components)
leftAligned
- if true the actions will be added to the left area of the toolbar, otherwise they'll be added to the rightcomponents
- one or more components to addpublic void addSeparator(boolean leftAligned)
leftAligned
- if true the separator will be added to the left side of the toolbar, otherwise the rightpublic void setActionsSecondary(javax.swing.Action... actions)
actions
-public void setActionsSecondary(java.lang.String moreActionsText, javax.swing.Action... actions)
moreActionsText
- the name (including mnemonic) for the drop list button, or null to accept the default.actions
-public void setSearch(SearchField.Style searchStyle, java.lang.String searchPrompt)
searchStyle
- set the style of the searchsearchPrompt
- set the hint text to appear in the search field
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |