14 Using Menus, Toolbars, and Toolboxes

14.2.1 How to Create and Use Menus in a Menu Bar

To create a menu, you first have to create a menu bar to hold the menus. You then add and configure menu and commandMenuItem components as needed.

To create and use menus in a menu bar:

1. Create a menuBar component by dragging and dropping a Panel Menu Bar from the Component Palette to the JSF page.

2. Insert the desired number of menu components into the menu bar by dragging a Menu from the Component Palette and dropping it as a child to the menuBar component.

   You can also insert commandMenuItem components directly into a menu bar by dragging and dropping a Menu Item from the Component Palette. Doing so creates a commandMenuItem component that renders similar to a toolbar button.

   Tip:

   Menu bars also allow you to use the iterator, switcher, and group components as direct children, providing these components wrap child components that would usually be direct children of the menu bar.

3. For each menu component, expand the Appearance section in the Property Inspector and set the following attributes:

   • text: Enter text for the menu's label. If you wish to also provide an access key (a letter a user can use to access the menu using the keyboard), then leave this attribute blank and enter a value for textAndAccessKey instead.

   • textAndAccessKey: Enter the menu label and access key, using conventional ampersand notation. For example, &File sets the menu label to File, and at the same time sets the menu access key to the letter F. For more information about access keys and the ampersand notation, see Section 22.3, "Defining Access Keys for ADF Faces Components".

   • icon: Enter the URI of the image file you want to display before the menu item label.

4. If you want the menu to be detachable, expand the Behavior section in the Property Inspector. Set the detachable attribute to true if you want to make this menu a detachable menu (as shown in Figure 14-5). At runtime, the user can drag the menu to detach it, and drop it anywhere on the screen (as shown in Figure 14-6).

5. If you want the menu to use lazy content delivery, expand the Other section in the Property Inspector and set the ContentDelivery attribute to lazy.

   Note:

   If you use lazy content delivery, any accelerators set on the child commandMenuItem components will not work because the contents of the menu are not known until the menu is accessed. If your menu must support accelerators, then the contentDelivery attribute must be set to immediate.

   Note:

   If the menu will be used inside a popup dialog or window, leave the content delivery set to immediate, because the popup dialog or window will determine the content delivery for the menu.

6. Within each menu component, to create menu items that invoke some sort of action along with navigation, drag and drop MenuItems from the Component Palette to insert a series of commandMenuItem components to define the items in the vertical menu.

   If needed, you can wrap the commandMenuItem components within a group component to display the items as a group. Example 14-1 shows simplified code for grouping the Folders and Search menu items in one group, the Table, Tree Table and List menu items in a second group, and the Refresh menu item by itself at the end.

   Example 14-1 Grouping Menu Items

   <af:menu id="viewMenu"
     <af:group>
       <af:commandMenuItem type="check" text="Folders"/>
       <af:commandMenuItem type="check" text="Search"/>
     </af:group>
     <af:group>
       <af:commandMenuItem type="radio" text="Table"/>
       <af:commandMenuItem type="radio" text="Tree Table"/>
       <af:commandMenuItem type="radio" text="List"/>
     </af:group>
     <af:commandMenuItem text="Refresh"/>
   </menu>
   

   Figure 14-12 shows how the menu is displayed.

   Figure 14-12 Grouped commandMenuItem Components in a Menu

   
   

   Tip:

   By default, only up to 14 items are displayed in the menu. If more than 14 items are added to a menu, the first 14 are displayed along with a scrollbar, which can be used to access the remaining items. If you wish to change the number of visible items, edit the af|menu {-tr-visible-items} skinning key. For more information, see Chapter 20, "Customizing the Appearance Using Styles and Skins".

   You can also insert another menu component into an existing menu component to create a submenu (as shown in Figure 14-3).

   Tip:

   Menus also allow you to use the iterator and switcher components as direct children, providing these components wrap child components that would usually be direct children of the menu.

7. For each commandMenuItem component, expand the Common section in the Property Inspector and set the following attributes:

   • type: Specify a type for this menu item. When a menu item type is specified, ADF Faces adds a visual indicator (such as a checkmark) and a toggle behavior to the menu item. At runtime, when the user selects a menu item with a specified type (other than default), ADF Faces toggles the visual indicator or menu item label. Use one of the following acceptable type values:

     • check: Toggles a checkmark next to the menu item label. The checkmark is displayed when the menu item is chosen.

     • radio: Toggles a radio button next to the menu item label. The radio button is displayed when the menu item is chosen.

     • antonym: Toggles the menu item label. The value set in the selectedText attribute is displayed when the menu item is chosen, instead of the menu item defined by the value of text or textAndAccessKey (which is what is displayed when the menu item is not chosen). If you select this type, you must set a value for the selectedText attribute.

     • default: Assigns no type to this menu item. The menu item is displayed in the same manner whether or not it is chosen.

   • text: Enter text for the menu item's label. If you wish to also provide an access key (a letter a user can use to access the item using the keyboard), then leave this attribute blank and enter a value for the textAndAccessKey attribute instead. Or, you can set the access key separately using the accessKey attribute.

   • selected: Set to true to have this menu item appear to be chosen. The selected attribute is supported for check-, radio-, and antonym-type menu items only.

   • selectedText: Set the alternate label to display for this menu item when the menu item is chosen. This value is ignored for all types except antonym.

   Example 14-2 shows the Special menu with one group of menu items configured to use radio buttons and another group of menu items configured to show checkmarks when chosen. The last group contains a menu item configured to be the antonym Open when it is first displayed, and then it toggles to Closed.

   Example 14-2 Using the Type Attribute in a commandMenuItem Component

   <af:menu text="Special">
     <af:group>
       <af:commandMenuItem text="Radio 1" type="radio" selected="true"
       <af:commandMenuItem text="Radio 2" type="radio"/>
       <af:commandMenuItem text="Radio 3" type="radio">
     </af:group>
     <af:group>
       <af:commandMenuItem text="Check 1" type="check" selected="true"
       <af:commandMenuItem text="Check 2" type="check"/>
     </af:group>
     <af:commandMenuItem text="Open (antonym)" type="antonym"
                         selectedText="Close (antonym)"/>
   </af:menu>
   

   Figure 14-13 shows how the menu will be displayed when it is first accessed.

   Figure 14-13 Menu Items Using the Type Attribute

   
   

8. Expand the Appearance section and set the following attributes:

   • icon: Enter the URI of the image file you want to display before the menu item label.

   • accelerator: Enter the keystroke that will activate this menu item's command when the item is chosen, for example, Control O. ADF Faces converts the keystroke and displays a text version of the keystroke (for example, Ctrl+O) next to the menu item label, as shown in Figure 14-3.

     Note:

     If you choose to use lazy content delivery, any accelerators set on the child commandMenuItem components will not work because the contents of the menu are not known until it is accessed. If your menu must support accelerator keys, then the contentDelivery attribute must be set to immediate.

   • textAndAccessKey: Enter the menu item label and access key, using conventional ampersand notation. For example, &Save sets the menu item label to Save, and at the same time sets the menu item access key to the letter S. For more information about access keys and the ampersand notation, see Section 22.3, "Defining Access Keys for ADF Faces Components".

9. Expand the Behavior section and set the following attributes:

   • action: Use an EL expression that evaluates to an action method in an object (such as a managed bean) that will be invoked when this menu item is chosen. The expression must evaluate to a public method that takes no parameters, and returns a java.lang.Object object.

     If you want to cause navigation in response to the action generated by commandMenuItem component, instead of entering an EL expression, enter a static action outcome value as the value for the action attribute. You then must either set the partialSubmit attribute to false, or use a redirect. For more information about configuring navigation in your application, see Section 2.3, "Defining Page Flows".

   • actionListener: Specify the expression that refers to an action listener method that will be notified when this menu item is chosen. This method can be used instead of a method bound to the action attribute, allowing the action attribute to handle navigation only. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.

10. To create a menu item that simply navigates (usually to an external site), drag and drop a Go Menu Item from the Component Palette as a child to the menu.

11. In the Property Inspector, expand the Other section and set the following attributes:

    • destination: Enter the URI of the page to which the link should navigate. For example, to navigate to the Oracle Corporation Home Page, you would enter http://www.oracle.com.

    • icon: Enter the URI of an image file.

    • targetFrame: Set the targetFrame attribute to specify where the new page should display. Acceptable values are

      • _blank: The link opens the document in a new window.

      • _parent: The link opens the document in the window of the parent. For example, if the link appeared in a dialog, the resulting page would render in the parent window.

      • _self: The link opens the document in the same page or region.

      • _top: The link opens the document in a full window, replacing the entire page.

    • text: Enter the text for the link.

      Tip:

      Instead, you can use the textAndAccessKey attribute to provide a single value that defines the label and the access key to use for the link. For information about how to define access keys, see Section 22.3.1, "How to Define Access Keys for an ADF Faces Component"

14.3.1 How to Create and Use Toolbars

If you are going to use more than one toolbar component on a page, or menu bars with toolbars, you first create the toolbox component to hold them. You then create the toolbars, and last, you create the toolbar buttons.

To create and use toolbars:

1. If you plan on using more than one toolbar or a combination of toolbars and menu bars, create a toolbox component by dragging and dropping a Toolbox component from the Layout section of the Component Palette.

   Tip:

   The panelHeader, showDetailHeader, and showDetailItem components support a toolbar facet for adding toolboxes and toolbars to section headers and accordion panel headers.

2. Create a toolbar component by dragging a Toolbar from the Common Components section of the Component Palette and dropping it onto the JSF page. If you are using a toolbox component, the toolbar should be a direct child of the toolbox component.

   Tip:

   Toolboxes also allow you to use the iterator, switcher, and group components as direct children, providing these components wrap child components that would usually be direct children of the toolbox.

3. If grouping more than one toolbar within a toolbox, expand the Appearance section and set the flex attributes on the toolbars to determine the relative sizes of each of the toolbars. The higher the number given for the flex attribute, the longer the toolbox will be. Example 14-3 shows that toolbar2 will be the longest, toolbar4 will be the next longest, and because their flex attributes are not set, the remaining toolbars will be the same size and shorter than toolbar4.

   Example 14-3 Flex Attribute Determines Length of Toolbars

   <af:toolbox>
     <af:toolbar id="toolbar1" flex="0">
       <af:commandToolbarButton text="ButtonA"/>
     </af:toolbar>
     <af:toolbar id="toolbar2" flex="2">
       <af:commandToolbarButton text="ButtonB"/>
     </af:toolbar>
     <af:toolbar id="toolbar3" flex="0">
       <af:commandToolbarButton text="ButtonC"/>
     </af:toolbar>
     <af:toolbar id="toolbar4" flex="1">
       <af:commandToolbarButton text="ButtonD"/>
     </af:toolbar>
   </af:toolbox>
   

   Performance Tip:

   At runtime, when available browser space is less than the space needed to display the contents of the toolbox, ADF Faces automatically displays overflow icons that enable users to select and navigate to those items that are out of view. The number of child components within a toolbox component, and the complexity of the children, will affect the performance of the overflow. You should set the size of the toolbox component to avoid overflow when possible. For more information, see Section 14.3.2, "What Happens at Runtime: Determining the Size of Toolbars".

   Tip:

   You can use the group component to group toolbars (or menu bars and toolbars) that you want to appear on the same row. If you do not use the group component, the toolbars will appear on subsequent rows.

   For information about how the flex attribute works, see Section 14.3.2, "What Happens at Runtime: Determining the Size of Toolbars".

4. Insert components into the toolbar as needed. To create a commandToolbarButton drag a ToolbarButton from the Component Palette and drop it as a direct child of the toolbar component.

   Tip:

   You can use the group component to wrap related buttons on the bar. Doing so inserts a separator between the groups, as shown surrounding the group for the Select Skin dropdown list and Refresh button shown in Figure 14-14.

   Toolbars also allow you to use the iterator and switcher components as direct children, providing these components wrap child components that would usually be direct children of the toolbar.

   Tip:

   You can place other components, such as command buttons and links, input components, and select components in a toolbar. However, they may not have the capability to stretch. For details about stretching the toolbar, see Step 9.

   Tip:

   If you plan to support changing the visible attribute of the button through active data (for example, data being pushed from the data source will determine whether nor not the toolbar is displayed), then you should use the activeCommandToolbarButton component instead of the commandToolbarButton component. Create an activeCommandToolbarButton component by dragging a ToolbarButton (Active) from the Component Palette.

5. For each commandToolbarButton component, expand the Common section of the Property Inspector and set the following attributes:

   • type: Specify a type for this toolbar button. When a toolbar button type is specified, an icon can be displayed when the button is clicked. Use one of the following acceptable type values:

     • check: Toggles to the depressedIcon value if selected or to the default icon value if not selected.

     • radio: When used with other toolbar buttons in a group, makes the button currently clicked selected, and toggles the previously clicked button in the group to unselected.

       Note:

       When setting the type to radio, you must wrap the toolbar button in a group tag that includes other toolbar buttons whose types are set to radio as well.

     • default: Assigns no type to this toolbar button.

   • selected: Set to true to have this toolbar button appear as though it is selected. The selected attribute is supported for checkmark- and radio-type toolbar buttons only.

   • icon: Enter the URI of the image file you want to display before this toolbar button label.

   • text: Enter the label for this toolbar button.

   • action: Use an EL expression that evaluates to an action method in an object (such as a managed bean) that will be invoked when a user presses this button. The expression must evaluate to a public method that takes no parameters, and returns a java.lang.Object object.

     If you want to cause navigation in response to the action generated by the button, instead of entering an EL expression, enter a static action outcome value as the value for the action attribute. You then must either set partialSubmit to false, or use a redirect. For more information about configuring navigation, see Section 2.3, "Defining Page Flows".

   • actionListener: Specify the expression that refers to an action listener method that will be notified when a user presses this button. This method can be used instead of a method bound to the action attribute, allowing the action attribute to handle navigation only. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.

6. Expand the Appearance section and set the following properties:

   • hoverIcon: Enter the URI of the image file you want to display when the mouse cursor is directly on top of this toolbar button.

   • depressedIcon: Enter the URI of the image file you want to display when the toolbar button is clicked.

7. Expand the Behavior section and set the actionDelivery attribute. Set the attribute to none if you do not want to fire an action event when the button is clicked. This is useful if you want the button to simply open a popup window. If set to none, you must have a popup component in the popup facet of the toolbar button (see Step 8), and you cannot have any value set for the action or actionListener attributes. Set to clientServer attribute if you want the button to fire an action event as a standard command component

8. To have a toolbar button invoke a popup menu, insert a menu component into the popup facet of the commandToolbarButton component. For information, see Section 14.2.1, "How to Create and Use Menus in a Menu Bar".

9. If you want a toolbar to stretch so that it equals the width of the containing parent component, set the stretchId attribute on the toolbar to be the ID of the component within the toolbar that should be stretched. This one component will stretch, while the rest of the components in the toolbar remain a static size.

   For example, in the File Explorer application, the inputText component that displays the selected folder's name is the one that should stretch, while the outputText component that displays the words "Current Folder" remains a static size, as shown in Example 14-4.

   Example 14-4 Using the stretchId Attribute

   <af:toolbar id="headerToolbar2" flex="2" stretchId="pathDisplay">
     <af:outputText id="currLocation" noWrap="true"
                    value="#{explorerBundle['menuitem.location']}"/>
     <af:inputText id="pathDisplay" simple="true" inlineStyle="width:100%"
                   contentStyle="width:100%"
                   binding="#{explorer.headerManager.pathDisplay}"
                   value="#{explorer.headerManager.displayedDirectory}"
                   autoSubmit="true"
                   validator="#{explorer.headerManager.validatePathDisplay}"/>
   </af:toolbar>
   

   You can also use the stretchId attribute to justify components to the left and right by inserting a spacer component, and setting that component ID as the stretchId for the toolbar, as shown in Example 14-5.

   Example 14-5 Using a Spacer to Justify Toolbar Components

   <af:toolbar flex="1" stretchId="stretch1">
     <af:commandToolbarButton text="Forward"
                              icon="/images/fwdarrow_gray.gif"
                              disabled="true"></af:commandToolbarButton>
     <af:commandToolbarButton icon="/images/uplevel.gif" />
     
   <!-- Insert a stretched spacer to push subsequent buttons to the right -->
   
     <af:spacer id="stretch1" clientComponent="true"/>
     
     <af:commandToolbarButton text="Reports" />
     <af:commandToolbarButton id="toggleRefresh"
                              text="Refresh:OFF" />
   </af:toolbar>
   

14.3.2 What Happens at Runtime: Determining the Size of Toolbars

When a page with a toolbar is first displayed or resized, the space needed for each toolbar is based on the value of the toolbar's flex attribute. The percentage of size allocated to each toolbar is determined by dividing its flex attribute value by the sum of all the flex attribute values. For example, say you have three toolbars in a toolbox, and those toolbars are grouped together to display on the same line. The first toolbar is given a flex attribute value of 1, the second toolbar also has a flex attribute value of 1, and the third has a flex attribute value of 2, giving a total of 4 for all flex attribute values. In this example, the toolbars would have the following allocation percentages:

• Toolbar 1: 1/4 = 25%

• Toolbar 2: 1/4 = 25%

• Toolbar 3: 2/4 = 50%

Once the allocation for the toolbars is determined, and the size set accordingly, each element within the toolbars are placed left to right (unless the application is configured to read right to left. For more information, see Section A.6.2.6, "Language Reading Direction"). Any components that do not fit are placed into the overflow list for the toolbar, keeping the same order as they would have if displayed, but from top to bottom instead of left to right.

14.3.3 What You May Need to Know About Toolbars

Toolbars are supported and rendered by parent components such as panelHeader, showDetailHeader, and showDetailItem, which have a toolbar facet for adding toolbars and toolbar buttons to section headers and accordion panel headers.

Note the following points about toolbars at runtime:

• A toolbar and its buttons do not display on a header if that header is in a collapsed state. The toolbar displays only when the header is in an expanded state.

• When the available space on a header is less than the space needed by a toolbar and all its buttons, ADF Faces automatically renders overflow icons that allow users to select hidden buttons from an overflow list.

• Toolbars do not render on printable pages.