Component MENUITEM

Overview

Graphical representation of a menu item. It typically is placed into MENUBAR, POPUPMENU or BUTTONMENU component.

The MENUITEM component is associated with some action that is triggered on server side.

Attribute summary

Typically used attributes

All attributes are

General attributes are

Positioning

Used inside: BUTTONMENU, MENU, MENUBAR, POPUPMENU

Attribute details

accessiblename

Text that is passed as control content to the accessible support devices (e.g. screen readers).

actionListener

Binding to server side method that processes the events coming from this component.

#{methodBinding}Method binding

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

#{tobedefined}Binding to IComponentAdapter instance

attributemacro

Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.

background

Background color of the component. Any RGB value can be chosen using format #rrggbb.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

clientname

Name that is assigned to the component at client side: there is no specific function associated with the name - but it can be used on client side to describe the component in a clearer way. The name is e.g. used by UI test tools that replay certain user interaction sequences - and that reference components via their name.

command

If used with MENUITEM component: command string that is passed to the action listener of the component referencing the popup menu item. - If used with ACTIVEX component: Command that is sent to the ActiveX control. Pay attention: commands will only be executed if they differ from the previously executed command in order to avoid double calling. The command is a semicolon separated list of property-set commands (set(propertyname)) and method calls (method(param1,param2)). ONLY String parameters are supported at the moment.

set(propertyName)Set a property of the ActiveX control.
invoke()Invoke of method
invoke(param1,param2)Invoke of method with parameters
set(propertyName);invoke(param1,param2)Concatenated command

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.

enabled

Indicator if component is enabled or not.

trueComponent is enabled.
falseComponent is not enabled.

font

Semicolon separated list of font attributes. Valid attributes are: faces (font family), size (integer number), weight (bold), posture (italic)

family:Arialfamily:Arial
family:Courierfamily:Courier
size:12size:12
weight:boldweight:bold
size:12;weight:boldsize:12;weight:bold
size:12;posture:italicsize:12;posture:italic

foreground

Foreground color of the component. Any RGB value can be chosen using format #rrggbb.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

hotkey

Definition of keyboard key that is associated with this menu item.

 No keyboard association (default)
ctrl-83Control key + s
alt-83Alt key + s
shift-83Shift key + s
ctrl-shift-83Control key + Shift key + s
10return
32space
37cursor left
38cursor up
39cursor right
40cursor down
33page up
34page down
36Begin
35End
27escape
127Del
65a
66b
67c
68d
69e
70f
71g
72h
73i
74j
75k
76l
77m
78n
79o
80p
81q
82r
83s
84t
85u
86v
87w
88x
89y
90z
480
491
502
513
524
535
546
557
568
579
112F1
113F2
114F3
115F4
116F5
117F6
118F7
119F8
120F9
121F10
122F11
123F12

hotkeyonly

A popup menu item may be used in order to define hotkeys. If you do not want the popup menu item in the menu at all, the set this attribute to true.

falseShow in menu (default)
trueDo not show, only serve as hotkey

image

Reference to image within your web application. The image is defined in an absolute way (e.g. /images/abc.png) - the root directory for absolute addressing is the directory of the web application.

/images/abc.pngImage /images/abc.png
/images/svg/def.svgImage /images/svg/def.svg

reference

Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

rendered

Flag that indicated if this component is rendered at all. If set to false then the component is not rendered - there is no component data sent to the client.

trueComponent is rendered (default)
falseComponent is not rendered

stylevariant

In CaptainCasa you can define styles definitions for components. A style definition is a definition of a set of default attribute values that are applied to the component. In case you want to differenciate between different usage types of the component you can apply multiple styles - and use the stylevariant attribute to select between.

text

Text that is shown and (dependent from the component type) edited inside the component. The terminator is a decimal byte value.

tooltip

Text that is shown as hint when the user stays with the mouse on top of the control for a while.

...anytext...Text that is displayed as tooltip.
server:trueIndicator that tooltip for the component is managed on server side. The actionListener will be invokde with events BaseActionEventTooltipStarted and BaseActionEventTooltipEnde. On server side you may implement some modeless popup in order to show some more complex tooltip
server:true;opendelay:1000Duration in milliseconds after which a tooltip event is triggered when the user moves the mouse on top of this component