A
JMenu
represents a menu that is implemented using the Java Swing JMenu class.
Yoix programs normally interact with the items contained in the menu
rather than the menu itself.
Nonetheless, there are some event handlers available and a program
can also read or write the following
JMenu
fields:
| alignment |
An
int
that controls the horizontal positioning of the text in the menu label, but
not the text of the components in the menu.
The value should be
LEFT,
CENTER,
RIGHT,
LEADING,
or
TRAILING,
which are all defined in
yoix.swing.
Reading returns the current alignment.
Writing immediately repaints the text using the new alignment.
The default value is
LEFT.
Adjusting the menu's label text alignment is not recommended.
| | autotrim |
An
int
that is
1
when white space is automatically trimmed from both ends of every string
read from or written to the
text
field, and
0
otherwise.
| | background |
The
Color
that is used to paint the background of the menu.
Reading returns a snapshot of the current color.
Writing immediately changes the background to the new color.
Storing
NULL
in
background
is special and means use the background of the nearest component
that contains the menu and was assigned a background color other than
NULL;
if no component qualifies the menu uses
VM.screen.background.
| | border |
An
Object
that should be a
Border,
Insets,
Number,
or
String
that describes the border that is drawn around this menu.
A
NULL
value, which is the default, means no border.
A
border
that is an
Insets
or
Number
is an easy way to describe margins
(i.e., an
EmptyBorder),
in units of 72 dots per inch, that are left around the sides of this menu.
A
border
that is a
String
is a quick way to surround this menu with a border that uses the
String
as its title.
Reading returns a snapshot of the current border.
Writing immediately sets the menu's border to the new value.
| | click([Number time]) |
A
Builtin
that causes the menu to behave as if it has just been interactively clicked.
The optional
time
argument, when supplied, is the number of seconds the menu will remain depressed.
| | components |
A
Dictionary
maintained by the interpreter that maps
tag
fields to actual menu components;
every menu component contained in the menu has an entry in the dictionary.
| | cursor |
An
Object
that should be an
int,
Image,
or
String
that selects the cursor shown when the pointer is over the menu.
A
cursor
that is an
int
should be one of the cursors defined in the
yoix.awt.Cursor
dictionary.
A
cursor
that is an
Image
can describe the cursor using its
size
and
hotspot
fields and often draws it using its
paint
function.
A
cursor
that is a
String
should be the name of a cursor that is already defined in
yoix.awt.Cursor
or the name a local a file or URL that contains a GIF or JPEG image
that will be used as the cursor.
Reading returns the current cursor.
Writing immediately changes the menu's cursor to the new value.
Storing
STANDARD_CURSOR
(the default) or
NULL
in
cursor
is special and means use the cursor assigned to the nearest component
that contains the menu and was assigned a cursor other than
STANDARD_CURSOR;
if no component qualifies the menu uses
DEFAULT_CURSOR.
| | doublebuffered |
An
int
that is
1
when the menu uses double-buffering to draw itself,
0
when it does not, and starts with a default value that is
selected by Java for the menu.
Reading returns the current double-buffering behavior.
Writing immediately sets the menu's double-buffering behavior to the new value.
Note that double-buffering may be required when transparent components are used.
| | dragenabled |
An
int
that should be set to
1
when this menu wants to use the automatic drag handling that Swing provides
for some components, and
0
(the default)
when it does not.
Components that do not provide automatic drag handling always return
0
when their
dragenabled
field is read, so storing
1
in
dragenabled
should only be viewed as a request for a service that may not be available.
Swing components can always take complete control of their drag and drop
handling using their
transferhandler
field or special drag and drop event handlers.
| | enabled |
An
int
that is
1
when the menu can respond to user input, and
0
when it can not.
The top-level application window that contains the menu always gets the
final say, so disabling that window always disables the menu.
Reading returns the current state.
Writing immediately sets the menu's state to the new value.
| | focusable |
An
int
that is non-zero (the default)
when the menu can accept the keyboard focus and zero
when it can not.
Reading returns the menu's current focusable state.
Writing immediately changes the menu's focusable state to the new value,
which means the focus is automatically transferred if the new value is zero
and the menu is the current focus owner.
| | focusowner |
A read-only
int
that is non-zero when the menu has the focus.
| | font |
The
Font,
or font name if it is a
String,
used to paint the characters stored in the
text
field.
Reading returns a snapshot of the current font.
Writing immediately repaints the text in the new font.
| | foreground |
The
Color
that is used to paint the characters stored in the
text
field.
Reading returns a snapshot of the current color.
Writing immediately repaints the text in the new color.
Storing
NULL
in
foreground
is special and means use the foreground of the nearest component
that contains the menu and was assigned a foreground color other than
NULL;
if no component qualifies the menu uses
VM.screen.foreground.
| | getEnabled(Object pattern) |
A
Builtin
that finds the first menu item with a command that matches
pattern,
which can be a
String
or
Regexp,
and returns
1
if it is currently enabled (i.e., it will respond when selected by a user),
0
if not, and
-1
if there is no match.
| | getState(Object pattern) |
A
Builtin
that finds the first checkbox or radiobutton menu item with a command that matches
pattern,
which can be a
String
or
Regexp,
and returns
1
if it is currently selected,
0
if not, and
-1
if there is no match.
| | icon |
A read-write
Image
to be used as the
defaulticon
for this menu.
This field is a convenience field and is equivalent to the
defaulticon
element in the
icons
dictionary discussed below.
| | icons |
A read-write
Dictionary
of
Image
fields that specify the icons to be used in the seven potential
states of the menu.
The seven fields are
defaulticon,
disabledicon,
disabledselectedicon,
pressedicon,
rollovericon,
rolloverselectedicon
and
selectedicon.
If
pressedicon
or
disabledicon
are not explicitly specified, the value of
defaulticon
is applied to them.
| | items |
A
Menu
that describes the menu configuration or an
Array
of the
JMenu
or
JMenuItem
objects that are actually in the menu.
Writing causes the new
Array
or
Menu
to be parsed and if there are no errors immediately resets the menu's contents.
As a special case, a
NULL
entry in the
Array
indicates that a menu separator bar should be placed at that location in the menu.
| | location |
A
Point
that determines the location of the menu
in a coordinate system that has its origin at the upper left corner
of the container closest to the menu (in the component hierarchy)
that actually contains it, positive x to the right, positive y down,
and a resolution of 72 dots per inch.
Reading returns a snapshot of the current location.
Writing is allowed, but layout managers usually get the final say, so setting
location
should be viewed as a request that may not be honored.
| | mnemonic |
An
int
that sets the keyboard mnemonic for the menu.
The integer value represents, in a case-insensitive manner, a single key on
the keyboard.
It is recommended that elements in the
yoix.swing.KeyCode
dictionary be used for assigning mnemonic values.
Refer to the Java
AbstractButton
documentation for more information about
mnemonic usage.
| | nextfocus |
An
Object
that identifies the component that receives the focus after this menu
when the focus traverses from one component to the next
(usually by means of the keyboard
TAB
character).
When
nextfocus
is a
String
it is assumed to be the tag associated with the target component,
which must belong to the same top-level container (e.g., the same
JFrame)
as this menu.
A
NULL
value means the component that gets the focus after this menu will be
selected by Java's default focus traversal policy.
Reading returns the value last stored or
NULL
if the value was a
String
that did not reference a component.
Writing immediately changes the component that gets the focus after this menu.
| | preferredsize |
A
Dimension
that is used by layout managers when they need to know the menu's
preferred size in units of 72 dots per inch.
A
NULL
value means the menu has no preference.
A non-positive height or width is allowed and simply means the menu
has no preference for that dimension.
Reading returns the current preferred size.
Writing changes the preferred size and immediately notifies
root.layoutmanager,
which means the components contained in
root
may be repositioned and resized.
| | root |
An
Object
that is automatically updated by the interpreter so it always references
the top-level component that currently owns the menu.
For example, add a menu to a menubar and the
root
field in the menu will be set to that menubar;
attach the menubar to a frame and root in the menubar and in the original
menu will be set to that frame.
| | setEnabled(Object pattern, int state) |
A
Builtin
that finds menu items with commands that match
pattern,
which can be a
String
or
Regexp,
and enables them (i.e., they respond when selected by a user) when
state
is non-zero and disables them when
state
is zero.
A return value of
-1
means there were no matches.
| | setState(Object pattern, int state) |
A
Builtin
that finds checkbox or radiobutton menu items with commands that match
pattern,
which can be a
String
or
Regexp,
and selects them when
state
is non-zero and deselects them when
state
is zero.
A return value of
-1
means there were no matches.
| | showing |
A read-only
int
that is non-zero when the menu is showing on the screen.
| | size |
A
Dimension
that determines the size of the menu
in units of 72 dots per inch.
Reading returns a snapshot of the current size.
Writing is allowed, but layout managers usually get the final say, so setting
size
should be viewed as a request that may not be honored.
| | tag |
A
String
used to identify the menu that is either supplied when
the menu is declared, or automatically generated otherwise.
| | text |
A
String
of characters that labels the menu within its container component.
Reading returns the current text.
Writing immediately paints the new text.
| | tooltiptext |
A
String
of characters that is displayed in a tightly sized pop-up window that
appears near the cursor whenever the cursor lingers over the menu.
Setting this value to
NULL
(the default)
disables the tooltip mechanism.
Reading returns the current tooltip text.
Writing immediately sets the new tooltip text.
| | transferhandler |
An
Object
that should be a
TransferHandler
or
String
that determines how the menu handles data transfer operations
like drag and drop.
A value that is a
String
but not
""
means the field named by the
String
should be used as the source and sink of the data that is transferred by
the menu.
The result is the same as assigning the
String
to the
property
field in a
TransferHandler
and then assigning that
TransferHandler
to
transferhandler.
The empty
String
""
is special and refers to the
TransferHandler
that Swing uses for automatic drag handling, if there is one.
Swing components that provide automatic drag handling start out with a
transferhandler
field that is not
NULL,
but the automatic drag handling is not enabled until
1
is stored in
dragenabled.
Swing components that provide their own drag and drop event handlers
currently must store
NULL
in
transferhandler
before those event handlers will start working.
| | visible |
An
int
that is
1
when the menu is visible, and
0
otherwise.
Reading returns the current visibility.
Writing immediately sets the menu's visibility to the new state.
|
Several permanent fields have not been documented and should not be
used in Yoix applications.
In addition, even though the
layer,
opaque,
nextfocus,
requestfocus,
and
requestfocusenabled
fields are defined, in most situations they have no effect and as a result
they have not been documented.
| |
| Event Handlers: |
componentHidden,
componentMoved,
componentResized,
componentShown,
dragDropEnd,
dragEnter,
dragExit,
dragGestureRecognized,
dragMouseMoved,
dragOver,
drop,
dropActionChanged,
focusGained,
focusLost,
invocationRun,
keyPressed,
keyReleased,
keyTyped,
mouseClicked,
mouseDragged,
mouseEntered,
mouseExited,
mouseMoved,
mousePressed,
mouseReleased,
mouseWheelMoved
| | |
| See Also: |
appendText,
BevelBorder,
Border,
EmptyBorder,
EtchedBorder,
invokeLater,
JButton,
JCanvas,
JCheckBox,
JCheckBoxMenuItem,
JChoice,
JColorChooser,
JComboBox,
JDesktopPane,
JDialog,
JFileChooser,
JFileDialog,
JFrame,
JInternalFrame,
JLabel,
JLayeredPane,
JList,
JMenuBar,
JMenuItem,
JPanel,
JPasswordField,
JPopupMenu,
JProgressBar,
JRadioButton,
JRadioButtonMenuItem,
JScrollBar,
JScrollPane,
JSeparator,
JSlider,
JSplitPane,
JTabbedPane,
JTable,
JTextArea,
JTextCanvas,
JTextField,
JTextPane,
JTextTerm,
JToggleButton,
JToolBar,
JTree,
JWindow,
LineBorder,
MatteBorder,
Menu,
postEvent,
SoftBevelBorder,
TransferHandler
|
|
