Client API. The Codename One framework your app is built on: this runs on the device, not in a backend.

public class Command

Object
Command

Known subtypesShareService, NavigationCommand

The Command class provides a useful extension to the ActionListener interface in cases where the same functionality may be accessed by several controls.

Fields

`public static final` `String DESKTOP_MENU = "DesktopMenu"`	Client property key carrying the desktop native-menu placement hint for this command.
`public static final` `String DESKTOP_MENU_APP = "App"`	Standard desktop menu placement: the macOS application menu.
`public static final` `String DESKTOP_MENU_ABOUT = "About"`	The About standard command, read as `#DESKTOP_ROLE_ABOUT`: placed where each platform keeps it, see `#setDesktopRole(String)`.
`public static final` `String DESKTOP_MENU_PREFERENCES = "Preferences"`	The Settings standard command, read as `#DESKTOP_ROLE_SETTINGS`: placed where each platform keeps it, see `#setDesktopRole(String)`.
`public static final` `String DESKTOP_MENU_QUIT = "Quit"`	The Quit standard command, read as `#DESKTOP_ROLE_QUIT`: placed where each platform keeps it, see `#setDesktopRole(String)`.
`public static final` `String DESKTOP_MENU_FILE = "File"`	Standard desktop menu placement: the File menu.
`public static final` `String DESKTOP_MENU_EDIT = "Edit"`	Standard desktop menu placement: the Edit menu.
`public static final` `String DESKTOP_MENU_VIEW = "View"`	Standard desktop menu placement: the View menu.
`public static final` `String DESKTOP_MENU_WINDOW = "Window"`	Standard desktop menu placement: the Window menu.
`public static final` `String DESKTOP_MENU_HELP = "Help"`	Standard desktop menu placement: the Help menu.
`public static final` `String DESKTOP_MENU_GROUP = "DesktopMenuGroup"`	Client property key carrying the separator group of this command within its desktop menu (as an `Integer`), see `#setDesktopMenuGroup(int)`.
`public static final` `String DESKTOP_SEPARATOR = "DesktopSeparator"`	Client property key marking a command as a separator line in the desktop menu, see `#createDesktopSeparator(String)`.
`public static final` `String DESKTOP_CHECKED = "DesktopChecked"`	Client property key carrying the checked state of a check or radio desktop menu item (as a `Boolean`).
`public static final` `String DESKTOP_RADIO_GROUP = "DesktopRadioGroup"`	Client property key carrying the name of the radio group of a desktop menu item, see `#setDesktopRadioGroup(String)`.
`public static final` `String DESKTOP_SHORTCUT_KEY = "DesktopShortcutKey"`	Client property key carrying the upper-cased character of the desktop keyboard accelerator (as an `Integer`), see `#setDesktopShortcut(char, int)`.
`public static final` `String DESKTOP_SHORTCUT_MODIFIERS = "DesktopShortcutModifiers"`	Client property key carrying the modifier bit-mask of the desktop keyboard accelerator (as an `Integer`), see `#setDesktopShortcut(char, int)`.
`public static final int DESKTOP_SHORTCUT_MODIFIER_PRIMARY = 1`	Accelerator modifier flag for the platform’s primary command key: Command on macOS, Control on Windows/Linux.
`public static final int DESKTOP_SHORTCUT_MODIFIER_SHIFT = 2`	Accelerator modifier flag for the Shift key.
`public static final int DESKTOP_SHORTCUT_MODIFIER_ALT = 4`	Accelerator modifier flag for the Alt/Option key.
`public static final` `String DESKTOP_ROLE = "DesktopRole"`	Client property key carrying the standard desktop role of this command, one of the `DESKTOP_ROLE_*` constants.
`public static final` `String DESKTOP_ROLE_ABOUT = "about"`	Standard command: shows the application’s About information.
`public static final` `String DESKTOP_ROLE_SETTINGS = "settings"`	Standard command: opens the application’s settings.
`public static final` `String DESKTOP_ROLE_QUIT = "quit"`	Standard command: quits the application.
`public static final` `String DESKTOP_ROLE_HIDE_APP = "hide"`	Standard command: hides the application.
`public static final` `String DESKTOP_ROLE_NEW = "new"`	Standard command: creates a new document.
`public static final` `String DESKTOP_ROLE_OPEN = "open"`	Standard command: opens a document.
`public static final` `String DESKTOP_ROLE_SAVE = "save"`	Standard command: saves the document.
`public static final` `String DESKTOP_ROLE_SAVE_AS = "saveAs"`	Standard command: saves the document under a new name.
`public static final` `String DESKTOP_ROLE_CLOSE = "close"`	Standard command: closes the document or window.
`public static final` `String DESKTOP_ROLE_PRINT = "print"`	Standard command: prints.
`public static final` `String DESKTOP_ROLE_UNDO = "undo"`	Standard command: undo.
`public static final` `String DESKTOP_ROLE_REDO = "redo"`	Standard command: redo.
`public static final` `String DESKTOP_ROLE_CUT = "cut"`	Standard command: cut.
`public static final` `String DESKTOP_ROLE_COPY = "copy"`	Standard command: copy.
`public static final` `String DESKTOP_ROLE_PASTE = "paste"`	Standard command: paste.
`public static final` `String DESKTOP_ROLE_SELECT_ALL = "selectAll"`	Standard command: select all.
`public static final` `String DESKTOP_ROLE_FIND = "find"`	Standard command: find.
`public static final` `String DESKTOP_ROLE_FULL_SCREEN = "fullScreen"`	Standard command: toggles full screen.
`public static final` `String DESKTOP_ROLE_MINIMIZE = "minimize"`	Standard command: minimizes the window.
`public static final` `String DESKTOP_ROLE_ZOOM = "zoom"`	Standard command: zooms (macOS) or maximizes the window.
`public static final` `String DESKTOP_ROLE_HELP = "help"`	Standard command: opens the application’s help.
`public static final` `String DESKTOP_PLATFORMS = "DesktopPlatforms"`	Client property key carrying the platforms a command is published on, see `#setDesktopPlatforms(String...)`.
`public static final` `String DESKTOP_ENABLED_WHEN_MODIFIED = "DesktopEnabledWhenModified"`	Client property key that makes a command’s enabled state follow the document-modified state of its form or window (as a `Boolean`), see `#setDesktopEnabledWhenModified(boolean)`.

Constructors

`public Command(String command)`	Creates a new instance of Command
`public Command(String command, Image icon)`	Creates a new instance of Command
`public Command(String command, int id)`	Creates a new instance of Command
`public Command(String command, Image icon, int id)`	Creates a new instance of Command

Methods

`public static` `Command create(String name, Image icon, ActionListener ev)`	Creates a new command instance that encapsulates the action listener and details, the main value of this approach is in our ability to write commands using the shorthand lambda syntax of Java 8.
`public static` `Command createMaterial(String name, char icon, ActionListener ev)`	Creates a new command instance that encapsulates the action listener and details, the main value of this approach is in our ability to write commands using the shorthand lambda syntax of Java 8.
`public int getId()`	Return the command ID
`public` `String getCommandName()`	gets the Command Name
`public void setCommandName(String command)`	sets the Command name
`public` `Image getIcon()`	Returns the icon representing the command
`public void setIcon(Image icon)`	Sets the icon for the command
`public` `String toString()`	Returns a string representation of the object
`public` `Image getPressedIcon()`	Indicates the icon that is displayed on the button when the button is in pressed state
`public void setPressedIcon(Image pressedIcon)`	Indicates the icon that is displayed on the button when the button is in pressed state
`public` `Image getDisabledIcon()`	Indicates the icon that is displayed on the button when the button is in the disabled state
`public void setDisabledIcon(Image disabledIcon)`	Indicates the icon that is displayed on the button when the button is in the disabled state
`public` `Image getRolloverIcon()`	Indicates the icon that is displayed on the button when the button is in rolled over state
`public void setRolloverIcon(Image rolloverIcon)`	Indicates the icon that is displayed on the button when the button is in rolled over state
`public boolean equals(Object obj)`	compare two commands
`public int hashCode()`	Allows storing commands in a vector/hashtable
`public void actionPerformed(ActionEvent evt)`	This method is called when the soft button/Menu item is clicked
`public boolean isDisposesDialog()`	Indicates whether this command causes the dialog to dispose implicitly, defaults to true
`public void setDisposesDialog(boolean disposesDialog)`	Indicates whether this command causes the dialog to dispose implicitly, defaults to true
`public boolean isEnabled()`	Allows disabling/enabling the command
`public void setEnabled(boolean enabled)`	Allows disabling/enabling the command
`public` `Object getClientProperty(String key)`	The client properties are a useful way to associate meta-data with a command without subclassing
`public void putClientProperty(String key, Object value)`	The client properties are a useful way to associate meta-data with a command without sub classing
`public` `Command setDesktopMenu(String menu)`	Sets the desktop native-menu placement hint for this command.
`public` `String getDesktopMenu()`	Returns the desktop native-menu placement hint, or null when unset.
`public` `Command setDesktopMenuGroup(int group)`	Places this command in a separator group within its desktop menu.
`public int getDesktopMenuGroup()`	Returns the separator group set with `#setDesktopMenuGroup(int)`, 0 when unset.
`public static` `Command createDesktopSeparator(String menu)`	Creates a command that shows as a separator line in a desktop native menu, at the position it is added in.
`public boolean isDesktopSeparator()`	True when this command was created by `#createDesktopSeparator(String)`.
`public` `Command setDesktopChecked(boolean checked)`	Makes this command a check item in the desktop native menu and sets its state.
`public boolean isDesktopCheckable()`	True when this command is a check or radio item, see `#setDesktopChecked(boolean)`.
`public boolean isDesktopChecked()`	The checked state of a check or radio item, false when the command is not checkable.
`public` `Command setDesktopRadioGroup(String group)`	Makes this command a radio item of the named group in the desktop native menu.
`public` `String getDesktopRadioGroup()`	Returns the radio group set with `#setDesktopRadioGroup(String)`, or null.
`public` `Command setDesktopShortcut(char keyChar)`	Assigns a keyboard accelerator to this command for the desktop native menu bar using the platform’s primary modifier (Command on macOS, Control elsewhere).
`public` `Command setDesktopShortcut(char keyChar, int modifiers)`	Assigns a keyboard accelerator to this command for the desktop native menu bar.
`public int getDesktopShortcutKeyChar()`	Returns the upper-cased accelerator character assigned via `#setDesktopShortcut(char, int)`, or 0 when no accelerator is set.
`public int getDesktopShortcutModifiers()`	Returns the accelerator modifier bit-mask assigned via `#setDesktopShortcut(char, int)`, or 0 when no accelerator is set.
`public` `Command setDesktopRole(String role)`	Marks this command as one of the standard commands every desktop application has, so the native menu bar puts it where the platform’s own applications do: About, Settings and Quit in the application menu on macOS; About under Help, Options under Tools and Exit under File on Windows; Preferences under Edit on Linux.
`public` `String getDesktopRole()`	Returns the standard desktop role, or null when unset.
`public static` `Command createDesktopRole(String role, ActionListener listener)`	Creates a command for a standard desktop role, named the way the running platform names it: “Quit” on macOS and Linux and “Exit” on Windows, “Settings”, “Options” or “Preferences”, “About” followed by the application name.
`public` `Command setDesktopPlatforms(String... platforms)`	Publishes this command on the native menu bar of the listed platforms only, for a command that only makes sense on some of them.
`public boolean isDesktopPlatform(String platform)`	True when this command is published on the native menu bar of the named platform.
`public` `Command setDesktopEnabledWhenModified(boolean follow)`	Makes this command’s enabled state follow the document-modified state of the form or window publishing it: enabled while the document has unsaved changes, disabled once it is saved.
`public boolean isDesktopEnabledWhenModified()`	True when this command’s enabled state follows the document-modified state.
`public char getMaterialIcon()`
`public void setMaterialIcon(char materialIcon)`
`public float getIconGapMM()`	The gap between the text and the icon in millimeters or -1 for default
`public void setIconGapMM(float iconGapMM)`	The gap between the text and the icon in millimeters or -1 for default
`public float getMaterialIconSize()`
`public void setMaterialIconSize(float materialIconSize)`
`public` `Font getIconFont()`
`public void setIconFont(Font iconFont)`

Inherited methods

From Object

getClass, notify, notifyAll, wait, wait, wait, clone, finalize

Field details

DESKTOP_MENU

public static final String DESKTOP_MENU = "DesktopMenu"

Client property key carrying the desktop native-menu placement hint for this command. When a desktop app bridges its commands to the native menu bar (title-bar mode native/custom), the value selects which menu the command appears under. Recognized values (case-insensitive): #DESKTOP_MENU_APP, #DESKTOP_MENU_ABOUT, #DESKTOP_MENU_PREFERENCES, #DESKTOP_MENU_QUIT, #DESKTOP_MENU_FILE, #DESKTOP_MENU_EDIT, #DESKTOP_MENU_VIEW, #DESKTOP_MENU_WINDOW, #DESKTOP_MENU_HELP. Any other value becomes a top-level menu with that literal title. Commands without the hint are grouped under a default application-commands menu.

The value is a path: "File/Open Recent" puts the command in an “Open Recent” submenu of the File menu, created on demand, and deeper paths nest further. The first segment keeps the meaning above. Write // for a slash that is part of a title.

DESKTOP_MENU_APP

public static final String DESKTOP_MENU_APP = "App"

Standard desktop menu placement: the macOS application menu. Platforms without one put these commands in File.

DESKTOP_MENU_ABOUT

public static final String DESKTOP_MENU_ABOUT = "About"

The About standard command, read as #DESKTOP_ROLE_ABOUT: placed where each platform keeps it, see #setDesktopRole(String).

DESKTOP_MENU_PREFERENCES

public static final String DESKTOP_MENU_PREFERENCES = "Preferences"

The Settings standard command, read as #DESKTOP_ROLE_SETTINGS: placed where each platform keeps it, see #setDesktopRole(String).

DESKTOP_MENU_QUIT

public static final String DESKTOP_MENU_QUIT = "Quit"

The Quit standard command, read as #DESKTOP_ROLE_QUIT: placed where each platform keeps it, see #setDesktopRole(String).

DESKTOP_MENU_FILE

public static final String DESKTOP_MENU_FILE = "File"

Standard desktop menu placement: the File menu.

DESKTOP_MENU_EDIT

public static final String DESKTOP_MENU_EDIT = "Edit"

Standard desktop menu placement: the Edit menu.

DESKTOP_MENU_VIEW

public static final String DESKTOP_MENU_VIEW = "View"

Standard desktop menu placement: the View menu.

DESKTOP_MENU_WINDOW

public static final String DESKTOP_MENU_WINDOW = "Window"

Standard desktop menu placement: the Window menu.

DESKTOP_MENU_HELP

public static final String DESKTOP_MENU_HELP = "Help"

Standard desktop menu placement: the Help menu.

DESKTOP_MENU_GROUP

public static final String DESKTOP_MENU_GROUP = "DesktopMenuGroup"

Client property key carrying the separator group of this command within its desktop menu (as an Integer), see #setDesktopMenuGroup(int).

DESKTOP_SEPARATOR

public static final String DESKTOP_SEPARATOR = "DesktopSeparator"

Client property key marking a command as a separator line in the desktop menu, see #createDesktopSeparator(String).

DESKTOP_CHECKED

public static final String DESKTOP_CHECKED = "DesktopChecked"

Client property key carrying the checked state of a check or radio desktop menu item (as a Boolean). Its presence makes the item checkable, see #setDesktopChecked(boolean).

DESKTOP_RADIO_GROUP

public static final String DESKTOP_RADIO_GROUP = "DesktopRadioGroup"

Client property key carrying the name of the radio group of a desktop menu item, see #setDesktopRadioGroup(String).

DESKTOP_SHORTCUT_KEY

public static final String DESKTOP_SHORTCUT_KEY = "DesktopShortcutKey"

Client property key carrying the upper-cased character of the desktop keyboard accelerator (as an Integer), see #setDesktopShortcut(char, int).

DESKTOP_SHORTCUT_MODIFIERS

public static final String DESKTOP_SHORTCUT_MODIFIERS = "DesktopShortcutModifiers"

Client property key carrying the modifier bit-mask of the desktop keyboard accelerator (as an Integer), see #setDesktopShortcut(char, int).

DESKTOP_SHORTCUT_MODIFIER_PRIMARY

public static final int DESKTOP_SHORTCUT_MODIFIER_PRIMARY = 1

Accelerator modifier flag for the platform’s primary command key: Command on macOS, Control on Windows/Linux. This is the modifier used by the vast majority of menu shortcuts so it’s the default.

DESKTOP_SHORTCUT_MODIFIER_SHIFT

public static final int DESKTOP_SHORTCUT_MODIFIER_SHIFT = 2

Accelerator modifier flag for the Shift key.

DESKTOP_SHORTCUT_MODIFIER_ALT

public static final int DESKTOP_SHORTCUT_MODIFIER_ALT = 4

Accelerator modifier flag for the Alt/Option key.

DESKTOP_ROLE

public static final String DESKTOP_ROLE = "DesktopRole"

Client property key carrying the standard desktop role of this command, one of the DESKTOP_ROLE_* constants. See #setDesktopRole(String).

DESKTOP_ROLE_ABOUT

public static final String DESKTOP_ROLE_ABOUT = "about"

Standard command: shows the application’s About information. In the application menu on macOS, at the foot of Help on Windows and Linux.

DESKTOP_ROLE_SETTINGS

public static final String DESKTOP_ROLE_SETTINGS = "settings"

Standard command: opens the application’s settings. “Settings” in the application menu on macOS, “Options” under Tools on Windows, “Preferences” at the foot of Edit on Linux.

DESKTOP_ROLE_QUIT

public static final String DESKTOP_ROLE_QUIT = "quit"

Standard command: quits the application. “Quit” on macOS and Linux, “Exit” on Windows, and absent from a browser page, which cannot quit.

DESKTOP_ROLE_HIDE_APP

public static final String DESKTOP_ROLE_HIDE_APP = "hide"

Standard command: hides the application. macOS only.

DESKTOP_ROLE_NEW

public static final String DESKTOP_ROLE_NEW = "new"

Standard command: creates a new document.

DESKTOP_ROLE_OPEN

public static final String DESKTOP_ROLE_OPEN = "open"

Standard command: opens a document.

DESKTOP_ROLE_SAVE

public static final String DESKTOP_ROLE_SAVE = "save"

Standard command: saves the document. Follows the document-modified state of its form or window, see Form#setDocumentModified(boolean).

DESKTOP_ROLE_SAVE_AS

public static final String DESKTOP_ROLE_SAVE_AS = "saveAs"

Standard command: saves the document under a new name.

DESKTOP_ROLE_CLOSE

public static final String DESKTOP_ROLE_CLOSE = "close"

Standard command: closes the document or window.

DESKTOP_ROLE_PRINT

public static final String DESKTOP_ROLE_PRINT = "print"

Standard command: prints.

DESKTOP_ROLE_UNDO

public static final String DESKTOP_ROLE_UNDO = "undo"

Standard command: undo.

DESKTOP_ROLE_REDO

public static final String DESKTOP_ROLE_REDO = "redo"

Standard command: redo.

DESKTOP_ROLE_CUT

public static final String DESKTOP_ROLE_CUT = "cut"

Standard command: cut.

DESKTOP_ROLE_COPY

public static final String DESKTOP_ROLE_COPY = "copy"

Standard command: copy.

DESKTOP_ROLE_PASTE

public static final String DESKTOP_ROLE_PASTE = "paste"

Standard command: paste.

DESKTOP_ROLE_SELECT_ALL

public static final String DESKTOP_ROLE_SELECT_ALL = "selectAll"

Standard command: select all.

DESKTOP_ROLE_FIND

public static final String DESKTOP_ROLE_FIND = "find"

Standard command: find.

DESKTOP_ROLE_FULL_SCREEN

public static final String DESKTOP_ROLE_FULL_SCREEN = "fullScreen"

Standard command: toggles full screen.

DESKTOP_ROLE_MINIMIZE

public static final String DESKTOP_ROLE_MINIMIZE = "minimize"

Standard command: minimizes the window. Absent from a browser page.

DESKTOP_ROLE_ZOOM

public static final String DESKTOP_ROLE_ZOOM = "zoom"

Standard command: zooms (macOS) or maximizes the window. Absent from a browser page.

DESKTOP_ROLE_HELP

public static final String DESKTOP_ROLE_HELP = "help"

Standard command: opens the application’s help.

DESKTOP_PLATFORMS

public static final String DESKTOP_PLATFORMS = "DesktopPlatforms"

Client property key carrying the platforms a command is published on, see #setDesktopPlatforms(String...).

DESKTOP_ENABLED_WHEN_MODIFIED

public static final String DESKTOP_ENABLED_WHEN_MODIFIED = "DesktopEnabledWhenModified"

Client property key that makes a command’s enabled state follow the document-modified state of its form or window (as a Boolean), see #setDesktopEnabledWhenModified(boolean).

Constructor details

Command

public Command(String command)

Creates a new instance of Command

Parameters

command String: the string that will be placed on the Soft buttons\Menu

Command

public Command(String command, Image icon)

Creates a new instance of Command

Parameters

command String: the string that will be placed on the Soft buttons\Menu
icon Image: the icon representing the command

Command

public Command(String command, int id)

Creates a new instance of Command

Parameters

command String: the string that will be placed on the Soft buttons\Menu
id int: user defined ID for a command simplifying switch statement code working with a command

Command

public Command(String command, Image icon, int id)

Creates a new instance of Command

Parameters

command String: the string that will be placed on the Soft buttons\Menu
icon Image: the icon representing the command
id int: user defined ID for a command simplifying switch statement code working with a command

Method details

create

public static Command create(String name, Image icon, ActionListener ev)

Creates a new command instance that encapsulates the action listener and details, the main value of this approach is in our ability to write commands using the shorthand lambda syntax of Java 8.

Parameters

name String: the name/title of the command
icon Image: the icon for the command
ev ActionListener: the even handler

Returns

a newly created Command instance

createMaterial

public static Command createMaterial(String name, char icon, ActionListener ev)

Creates a new command instance that encapsulates the action listener and details, the main value of this approach is in our ability to write commands using the shorthand lambda syntax of Java 8.

Parameters

name String: the name/title of the command
icon char: the icon for the command
ev ActionListener: the even handler

Returns

a newly created Command instance

getId

public int getId()

Return the command ID

Returns

the command ID

getCommandName

public String getCommandName()

gets the Command Name

Returns

the Command name

setCommandName

public void setCommandName(String command)

sets the Command name

getIcon

public Image getIcon()

Returns the icon representing the command

Returns

an icon representing the command

setIcon

public void setIcon(Image icon)

Sets the icon for the command

Parameters

icon Image: the new icon

toString

public String toString()

Returns a string representation of the object

Returns

Returns a string representation of the object

getPressedIcon

public Image getPressedIcon()

Indicates the icon that is displayed on the button when the button is in pressed state

Returns

icon used

setPressedIcon

public void setPressedIcon(Image pressedIcon)

Indicates the icon that is displayed on the button when the button is in pressed state

Parameters

pressedIcon Image: icon used

getDisabledIcon

public Image getDisabledIcon()

Indicates the icon that is displayed on the button when the button is in the disabled state

Returns

icon used

setDisabledIcon

public void setDisabledIcon(Image disabledIcon)

Indicates the icon that is displayed on the button when the button is in the disabled state

Parameters

disabledIcon Image: icon used

getRolloverIcon

public Image getRolloverIcon()

Indicates the icon that is displayed on the button when the button is in rolled over state

Returns

icon used

setRolloverIcon

public void setRolloverIcon(Image rolloverIcon)

Indicates the icon that is displayed on the button when the button is in rolled over state

Parameters

rolloverIcon Image: icon to use

equals

public boolean equals(Object obj)

compare two commands

Parameters

obj Object: a Command Object to compare

Returns

true if the obj has the same command name

hashCode

public int hashCode()

Allows storing commands in a vector/hashtable

Returns

unique hashcode for the command class

actionPerformed

public void actionPerformed(ActionEvent evt)

This method is called when the soft button/Menu item is clicked

Parameters

evt ActionEvent: the Event Object

isDisposesDialog

public boolean isDisposesDialog()

Indicates whether this command causes the dialog to dispose implicitly, defaults to true

setDisposesDialog

public void setDisposesDialog(boolean disposesDialog)

Indicates whether this command causes the dialog to dispose implicitly, defaults to true

isEnabled

public boolean isEnabled()

Allows disabling/enabling the command

Returns

the enabled

setEnabled

public void setEnabled(boolean enabled)

Allows disabling/enabling the command

Parameters

enabled boolean: the enabled to set

getClientProperty

public Object getClientProperty(String key)

The client properties are a useful way to associate meta-data with a command without subclassing

Parameters

key String: an arbitrary user key

Returns

an arbitrary user object

putClientProperty

public void putClientProperty(String key, Object value)

The client properties are a useful way to associate meta-data with a command without sub classing

Parameters

key String: an arbitrary user key
value Object: an arbitrary user object, null to remove

setDesktopMenu

public Command setDesktopMenu(String menu)

Sets the desktop native-menu placement hint for this command. See #DESKTOP_MENU.

Parameters

menu String: one of the DESKTOP_MENU_* constants or a custom top-level menu title

Returns

this command, for chaining

getDesktopMenu

public String getDesktopMenu()

Returns the desktop native-menu placement hint, or null when unset. See #DESKTOP_MENU.

Returns

the placement hint or null

setDesktopMenuGroup

public Command setDesktopMenuGroup(int group)

Places this command in a separator group within its desktop menu. Items of one menu are ordered by group, keeping the order they were added in within a group, and the native menu draws a separator line wherever the group changes. Commands default to group 0.

Parameters

group int: the group number, lower groups come first

Returns

this command, for chaining

getDesktopMenuGroup

public int getDesktopMenuGroup()

Returns the separator group set with #setDesktopMenuGroup(int), 0 when unset.

Returns

the group number

createDesktopSeparator

public static Command createDesktopSeparator(String menu)

Creates a command that shows as a separator line in a desktop native menu, at the position it is added in. It has no label and never runs. Where groups already separate the items (#setDesktopMenuGroup(int)) it is not needed.

Parameters

menu String: the menu path the separator goes in, see #setDesktopMenu(String)

Returns

the separator command

isDesktopSeparator

public boolean isDesktopSeparator()

True when this command was created by #createDesktopSeparator(String).

Returns

true for a separator

setDesktopChecked

public Command setDesktopChecked(boolean checked)

Makes this command a check item in the desktop native menu and sets its state. When the user picks the item the state flips before the command runs, so the action reads the new value from #isDesktopChecked(). Changing the state while the command is in the native menu updates the menu.

Parameters

checked boolean: the checked state

Returns

this command, for chaining

isDesktopCheckable

public boolean isDesktopCheckable()

True when this command is a check or radio item, see #setDesktopChecked(boolean).

Returns

true when the item shows a check state

isDesktopChecked

public boolean isDesktopChecked()

The checked state of a check or radio item, false when the command is not checkable.

Returns

the checked state

setDesktopRadioGroup

public Command setDesktopRadioGroup(String group)

Makes this command a radio item of the named group in the desktop native menu. At most one command of a group is checked: checking one, from the menu or with #setDesktopChecked(boolean), unchecks the others. Picking the checked item again leaves it checked.

Parameters

group String: the radio group name, null to make this an ordinary item again

Returns

this command, for chaining

getDesktopRadioGroup

public String getDesktopRadioGroup()

Returns the radio group set with #setDesktopRadioGroup(String), or null.

Returns

the radio group name or null

setDesktopShortcut

public Command setDesktopShortcut(char keyChar)

Assigns a keyboard accelerator to this command for the desktop native menu bar using the platform’s primary modifier (Command on macOS, Control elsewhere). For example setDesktopShortcut('S') produces Cmd+S / Ctrl+S next to the menu item. The hint is inert on platforms without a native menu bar, so it’s safe to set unconditionally.

Parameters

keyChar char: the accelerator character (case-insensitive)

Returns

this command, for chaining

setDesktopShortcut

public Command setDesktopShortcut(char keyChar, int modifiers)

Assigns a keyboard accelerator to this command for the desktop native menu bar. See #setDesktopShortcut(char) for the common case.

Parameters

keyChar char: the accelerator character (case-insensitive)
modifiers int: a bit-mask of #DESKTOP_SHORTCUT_MODIFIER_PRIMARY, #DESKTOP_SHORTCUT_MODIFIER_SHIFT and #DESKTOP_SHORTCUT_MODIFIER_ALT

Returns

this command, for chaining

getDesktopShortcutKeyChar

public int getDesktopShortcutKeyChar()

Returns the upper-cased accelerator character assigned via #setDesktopShortcut(char, int), or 0 when no accelerator is set.

Returns

the accelerator character or 0

getDesktopShortcutModifiers

public int getDesktopShortcutModifiers()

Returns the accelerator modifier bit-mask assigned via #setDesktopShortcut(char, int), or 0 when no accelerator is set.

Returns

the modifier bit-mask

setDesktopRole

public Command setDesktopRole(String role)

Marks this command as one of the standard commands every desktop application has, so the native menu bar puts it where the platform’s own applications do: About, Settings and Quit in the application menu on macOS; About under Help, Options under Tools and Exit under File on Windows; Preferences under Edit on Linux. Each role also brings the platform’s standard shortcut and its position within the menu.

What the command sets itself wins: an explicit #setDesktopMenu(String), #setDesktopMenuGroup(int) or #setDesktopShortcut(char, int) overrides the role’s. The label is the command’s own name; #createDesktopRole(String, ActionListener) creates a command named the way the running platform names the role (Quit or Exit, Settings or Options or Preferences). A role the platform has no place for (Hide outside macOS, Quit in a browser) leaves the command out of that platform’s menu bar.

Parameters

role String: one of the DESKTOP_ROLE_* constants, or null to clear it

Returns

this command, for chaining

getDesktopRole

public String getDesktopRole()

Returns the standard desktop role, or null when unset. See #setDesktopRole(String).

Returns

one of the DESKTOP_ROLE_* constants or null

createDesktopRole

public static Command createDesktopRole(String role, ActionListener listener)

Creates a command for a standard desktop role, named the way the running platform names it: “Quit” on macOS and Linux and “Exit” on Windows, “Settings”, “Options” or “Preferences”, “About” followed by the application name. The name can be translated through the cn1.menu.<role> resource key, for example cn1.menu.quit. See #setDesktopRole(String).

Parameters

role String: one of the DESKTOP_ROLE_* constants
listener ActionListener: the action, may be null

Returns

the new command

setDesktopPlatforms

public Command setDesktopPlatforms(String... platforms)

Publishes this command on the native menu bar of the listed platforms only, for a command that only makes sense on some of them. The names are mac, win, linux and web (the JavaScript port’s in-page menu). The command stays in the application’s own menus everywhere; only the native menu bar is affected.

Parameters

platforms String...: the platform names; none, or null, publishes it everywhere

Returns

this command, for chaining

isDesktopPlatform

public boolean isDesktopPlatform(String platform)

True when this command is published on the native menu bar of the named platform. See #setDesktopPlatforms(String...).

Parameters

platform String: mac, win, linux or web

Returns

true when no platform list is set or the list names this platform

setDesktopEnabledWhenModified

public Command setDesktopEnabledWhenModified(boolean follow)

Makes this command’s enabled state follow the document-modified state of the form or window publishing it: enabled while the document has unsaved changes, disabled once it is saved. On by default for #DESKTOP_ROLE_SAVE. Nothing changes until the application calls Form#setDocumentModified(boolean) or Window#setDocumentModified(boolean).

Parameters

follow boolean: true to follow the modified state

Returns

this command, for chaining

isDesktopEnabledWhenModified

public boolean isDesktopEnabledWhenModified()

True when this command’s enabled state follows the document-modified state. See #setDesktopEnabledWhenModified(boolean).

Returns

true when it follows the modified state

getMaterialIcon

public char getMaterialIcon()

Returns

the materialIcon

setMaterialIcon

public void setMaterialIcon(char materialIcon)

Parameters

materialIcon char: the materialIcon to set

getIconGapMM

public float getIconGapMM()

The gap between the text and the icon in millimeters or -1 for default

Returns

the iconGapMM

setIconGapMM

public void setIconGapMM(float iconGapMM)

The gap between the text and the icon in millimeters or -1 for default

Parameters

iconGapMM float: the iconGapMM to set

getMaterialIconSize

public float getMaterialIconSize()

Returns

the materialIconSize

setMaterialIconSize

public void setMaterialIconSize(float materialIconSize)

Parameters

materialIconSize float: the materialIconSize to set

getIconFont

public Font getIconFont()

Returns

the set iconFont or null if none defined (meaning for material icons instead of the system default MaterialDesign font

setIconFont

public void setIconFont(Font iconFont)

Parameters

iconFont Font: use iconFont for material icons instead of the system default MaterialDesign font