1.3.2.1. Parameter segment

Each parameter segment (Figure 1.6) consists of a checkbox , tooltip help , link to the parameter description , parameter name and various editable graphics part .

Figure 1.6. Parameter segment

Parameter segment

The checkbox specifies whether the parameter is chosen or not. If it is checked, the parameter is chosen.

The tooltip help displays parameter description defined in the parameter reference. If the mouse moves over the tooltip icon, a tooltip with parameter purpose appears (Figure 1.7).

Figure 1.7. Parameter tooltip

Parameter tooltip

After clicking on the tooltip icon, a dialog with parameter description is displayed (Figure 1.8).

Figure 1.8. Dialog with parameter description

Dialog with parameter description

After clicking on the icon representing a link leading to the parameter description, a web browser page with the parameter description at http://docbook.souceforge.net/release/current/doc/fo/ is opened.

After pressing the right mouse button on the link icon a popup menu appears. Menu item Open web browser opens the description page in a web browser, menu item Copy location copies the url of the description page into the clipboard (Figure 1.9).

Figure 1.9. Popup menu of parameter description

Popup menu of parameter description

Parameter default value, component and name are defined in the XML definition file placed in the docbook-params/. Placement of parameters within editor is defined in the configuration file config.xml.

If the parameter has a unit, then the standard editable graphics part is accompanied by a combo-box contening unit values (defined in types.xml by tags unit) (Figure 1.10).

Figure 1.10. Combo-box with units

Combo-box with units

Editable graphics parts
text-field (string, uri)

The text field is a basic text control that lets the user enter a small amount of text.

The text field can contain any character string.

combo-box (list)

The combo box lets the user to choose one of several choices from a drop-down list displayed by clicking the button.

The combo box contains a list of predefined values, none new value can be inserted.

combo-box-edit (list-open, font)

The editable combo box lets the user to choose one of several choices, user can type a value in the text field or click the button to display a drop-down list.

The editable combo box contains a list of predefined values and it is possible to insert any new value.

text-area (table, rtf)

The text area displays multiple lines of text, allowing the user to edit the text.

The text area can contain any text.

spinner-int (integer, number)

The spinner-int lets the user to choose one from a range of integer values. Like editable combo boxes, spinners generally allow the user to type in a value. Unlike combo boxes, spinners don't have a drop-down list that can cover up other components.

Spinner-int can contain only integer values, positive as well as negative.

spinner-float (float)

The spinner-float lets the user to choose one from a range of float values. Like editable combo boxes, spinners generally allow the user to type in a value. Unlike combo boxes, spinners don't have a drop-down list that can cover up other components.

Spinner-float can contain only float values, positive as well as negative.

color-chooser (color)

The color chooser lets user to choose a color from a list of predefined colors or to choose a color with help of the color palette.

The color is defined by its predefined name (defined in the configuration file types.xml by tag color) or by hexadecimal value #rrggbb (rr is a hexadecimal value of red color component, gg is a hexadecimal value of green color component and bb is a hexadecimal value of blue color component).

check-box (boolean)

The check box is a button that has only two states – checked or not.

Check box button represents type boolean – checked is true (yes), not checked is false (no).

file-chooser (filename)

The file chooser is used for choosing any file from file system. By clicking on the button Choose..., a standard file chooser dialog box is displayed.

spinner-float with unit combo-box (length)

The spinner-float with combo-box with units represents the parameter length.