This functionality is only available for certain module packages.

You are here: Reference > Form-UI > Actions > action

action

Clicking the <action> element initiates a defined action or a component method.

There are two types of component methods:

If there is no instance method for the method call to apply, a suitable class method is sought.

Both the run method of the action and the component method receive their parameters via the Arguments attribute. The arguments are to be transferred as a list.

An action can be represented as a text with the appearance of a hyperlink and a preceding image or as a button with an image. The default image of the action is replaced by the img attribute see also img).

Attribute name Usage Attribute values Default value Description
arguments optional List List of arguments which are passed to the run method of the action
bColor optional 0,0,0 to 255,255,255 System color Background color as RGB value
fColor optional 0,0,0 to 255,255,255 System color Font color as RGB value for type="link"
font optional Font name-style-size System font Font name, style, and size for displaying text
hSize optional Width of the element
EEC = width in characters
Web application = width in pixels
hSizeMax optional maximum width of the element
EEC = width in characters
Web application = width in pixels
hSizeMax optional maximum width of the element
EEC = width in characters
Web application = width in pixels
hSizeMaxPx optional maximum width of the element
EEC = width in pixels
Web application = width in pixels
hSizeMaxPx optional maximum width of the element
EEC = width in pixels
Web application = width in pixels
hSizeMin optional minimum width of the element
EEC = width in characters
Web application = width in pixels
hSizeMinPx optional minimum width of the element in pixels
hSizePx optional Width of the element in pixels
id required any unique ID, which is referred to as reference
img optional png, gif, jpg action.png assigns another image to the element
name required absolute name of the action
readonly optional true, false false true = action is disabled
false = action is enabled
refresh optional true, false true Element is rebuilt after each modification of the EO
showIcon optional true, false true true = icon is visible
false = icon is not visible
text optional the text to display can be calculated using the formula language
tooltip optional Text or Form-UI of the overlaying tooltip (see tooltip)
type optional link, button link Representation type of the action:
link = text with hyperlink
button = button
visible optional true, false true true = element is visible
true = element is invisible
vSize optional Height of the element
EEC = height in characters
Web application = height in pixels
vSizeMax optional maximum height of the element
EEC = height in characters
Web application = height in pixels
vSizeMaxPx optional maximum height of the element in pixels
vSizeMin optional minimum height of the element
EEC = height in characters
Web application = height in pixels
vSizeMinPx optional minimum height of the element in pixels
vSizePx optional Height of the element in pixels
Allowed sub-elements Quantity
tooltip 0..1

Action as hyperlink with yellow background:

The element is displayed with preceding default image as a hyperlink on yellow background. The action ShowReadmeAction is executed, whose absolute name is specified:

Action as a hyperlink with tooltip:

The element is displayed with preceding default image and tooltip as a hyperlink:

Action as a button:

The element is displayed as a button with default image:

Action as a disabled button:

The element is configured as a button with default image, but is displayed disabled by means of the attribute readonly:

Action as a link passes two arguments:

The element is defined as a link with text. Two arguments are passed, the value of the parameter Coordinate (0, 90, 180 or 270) and the project component this. The action determines a direction from the parameter value that is passed and writes it to the parameter CardinalPoints.

The action CalculateCoordinateAction in this example calls the Command CalculateCoordinate , which has been previously created specially for this purpose.

The following figure shows the method view of the command editor. Two arguments are defined (1) in it and the transfer of the arguments is implemented in Java code (2) of the Command.

The command is called by this action:

Calling an instance method:

The sample code illustrates a call to the CalculateCoordinate method of the Docu_UI_Configuration project component. Two arguments are passed, the value of the parameter Coordinate (0, 90, 180 or 270) and the project component this. The action determines a cardinal direction from the parameter value that is passed and writes it to the CardinalPoints parameter.