Monday, December 28, 2009

ADF 11g RC: Manipulating a components toolbar.

Last week I had a question regarding the Rich Text Editor in ADF 11g RC.

Is it possible to disable/enable or add/remove components form the rich text editor's toolbar? At first I didn't know the answer, but after some investigation it appears to be very simple.

The most important piece of the puzzle is to understand how the toolbar is constructed. According to the components documentation, the toolboxLayout property allows control over the layout of the toolbar. This is actually just an Array of Strings.

The built in strings the component recognizes are:
1) "all"
2) "font"
3) "history"
4) "color"
5) "formatAll"
6) "justify"
7) "list"
8) "indent"
9) "link"
10) "newline"
11) "stretch"

For more information on what these built in Strings do, refer to the online help of the component.

One of the options you have to change the toolbar is to bind the editor component to a backing bean. In this bean you can manipulate the list with the built in Strings.

Each of the entries in this select many checkbox correspondents with one of the properties in the toolbar.

Every time a checkbox is selected or deselected, the corresponding item in the toolbar will (dis-)appear. This happens because the autosubmit property of the checkbox is set to true, and in the toolbarItems() method, not only the list with selected checkboxes is updated, but also the bound richTextEditor is changed by calling its setToolboxLayout() method with the list of checked boxes as argument.

public void setToolbarItems(String[] toolbarItems) {
this.toolbarItems = toolbarItems;
for (int i = 0; i < toolbarItems.length; i++) {
toolbarItemMap.put(toolbarItems[i], Boolean.TRUE);

This results in a runtime changeable toolbar.

Note that with this knowledge we are also able to change the toolbar of a calendar component, because this toolbar consists of a set of built in Strings as well.
You can download a workspace with the toolbar functionality here.