com.ontimize.gui

Class MenuItem

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JMenuItem

com.ontimize.gui.MenuItem

All Implemented Interfaces:

FormComponent, IdentifiedElement, Internationalization, IDynamicItem, IParameterItem, HasPreferenceComponent, SecureElement, StatusComponent, ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, MenuElement, SwingConstants

public class MenuItem
extends JMenuItem
implements FormComponent, IdentifiedElement, SecureElement, StatusComponent, HasPreferenceComponent, IDynamicItem, IParameterItem

The main class to create an item of a menu, where attribute parameter is the actionCommand.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JMenuItem

JMenuItem.AccessibleJMenuItem

Nested classes/interfaces inherited from class javax.swing.AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attribute The menu item attribute.
protected boolean	dialog True when the form is opened in a dialog
protected boolean	dynamic
protected String	formManagerName The name of the FormManager
protected String	formName The form name to show
static String	MENU_ACCELERATOR The key of a menu accelerator.
protected boolean	restricted The condition of restricted.
protected String	shortcut The reference to shortcut.
protected String	statusText The status text reference.
protected String	text The menu text to show.

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
MenuItem(Hashtable parameters) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize()
void	free() Removes all listener menu items.
protected String	getAcceleratorPreferencesKey() Gets the accelerator preference key.
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager layout) Description method to return the constraints component to place correctly in parent container.
String	getFormManagerName()
String	getFormName()
String	getStatusText() Gets the StatusText variable.
Vector	getTextsToTranslate() Adds the attribute parameter to the vector to translate.
void	init(Hashtable parameters) Initializes parameters.
void	initPermissions() Initializes the permissions.
void	initPreferences(ApplicationPreferences aPrefs, String user) Initializes the application preferences.
boolean	isDialog()
boolean	isDynamic()
boolean	isRestricted() Gets the restricted condition.
void	setAccelerator(KeyStroke ks)
void	setComponentLocale(Locale l) Sets the component locale.
void	setDialog(boolean dialog)
void	setDynamic(boolean dynamic)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setFormName(String formName)
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setVisible(boolean vis) Description method to set visible or not the component according the boolean condition in parameter.

Methods inherited from class javax.swing.JMenuItem

actionPropertyChanged, addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getAccessibleContext, getComponent, getMenuDragMouseListeners, getMenuKeyListeners, getSubElements, getUIClassID, init, isArmed, menuSelectionChanged, paramString, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setArmed, setModel, setUI, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ontimize.gui.field.FormComponent

isEnabled

Field Detail

MENU_ACCELERATOR

public static final String MENU_ACCELERATOR

The key of a menu accelerator.

See Also:

Constant Field Values

statusText

protected String statusText

The status text reference. By default, null.

attribute

protected String attribute

The menu item attribute. By default, null.

text

protected String text

The menu text to show. Useful for items which have the same attr. By default, null.

Since:

5.2074EN

shortcut

protected String shortcut

The reference to shortcut. By default,"".

formName

protected String formName

The form name to show

dialog

protected boolean dialog

True when the form is opened in a dialog

formManagerName

protected String formManagerName

The name of the FormManager

dynamic

protected boolean dynamic

restricted

protected boolean restricted

The condition of restricted. By default, false.

Constructor Detail

MenuItem

public MenuItem(Hashtable parameters)

The class constructor. It initializes parameters, sets margin and register status component.

Parameters:

parameters - The hashtable with parameters

Method Detail

getConstraints

public Object getConstraints(LayoutManager layout)

Description copied from interface: FormComponent

Description method to return the constraints component to place correctly in parent container.

Specified by:

getConstraints in interface FormComponent

Parameters:

layout - the parent container reference

Returns:

the constraints for the component

init

public void init(Hashtable parameters)

Initializes parameters.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	The attribute.
status		attr	no	The text showed in status bar application. MainApplication translates this text according to the bundle.
icon			no	Specifies the file name of button icon. Complete or relative path from Ontimize class location, for example, if an icon is stored in com/ontimize/gui/images/item.gif, it would be correct to specify the path like: 'item.gif'. If not stored in any baseImage bundle, write the complete route
shortcut			no	The reference to shortcut (for example: 'ctrl + C')
mnemonic			no	Mnemonic letter. NOTE: This parameter has not been Internationalized yet
form			no	The form name to be opened
showdialog	yes/no	If the 'form' parameter is established the default values is 'yes'.Otherwise the default value is 'no'	no	Established whether the form is opened in a dialog
formmanager		no	no	The name of FormManager to show. If this parameter isn't established the value is taking from 'attr' parameter

getAttribute

public Object getAttribute()

Description copied from interface: IdentifiedElement

Gets the object attribute. This attribute allows to identify the object

Specified by:

getAttribute in interface IdentifiedElement

getTextsToTranslate

public Vector getTextsToTranslate()

Adds the attribute parameter to the vector to translate.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:

the vector with attribute parameter.

setResourceBundle

public void setResourceBundle(ResourceBundle resources)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Parameters:

resources - the new language bundle.

setComponentLocale

public void setComponentLocale(Locale l)

Sets the component locale.

Specified by:

setComponentLocale in interface Internationalization

Parameters:

l - the locale to set

free

public void free()

Removes all listener menu items.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

setVisible

public void setVisible(boolean vis)

Description copied from interface: FormComponent

Description method to set visible or not the component according the boolean condition in parameter.

Specified by:

setVisible in interface FormComponent

Overrides:

setVisible in class JComponent

Parameters:

vis - the visibility condition

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FormComponent

Description method to set enabled or not the component according the boolean condition in parameter.

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class JMenuItem

Parameters:

enabled - the enabled condition

initPermissions

public void initPermissions()

Initializes the permissions.

Specified by:

initPermissions in interface SecureElement

getStatusText

public String getStatusText()

Gets the StatusText variable.

Specified by:

getStatusText in interface StatusComponent

Returns:

the status text

isRestricted

public boolean isRestricted()

Gets the restricted condition.

Specified by:

isRestricted in interface SecureElement

Returns:

the restricted variable value.

setAccelerator

public void setAccelerator(KeyStroke ks)

Overrides:

setAccelerator in class JMenuItem

initPreferences

public void initPreferences(ApplicationPreferences aPrefs,
                   String user)

Initializes the application preferences.

Specified by:

initPreferences in interface HasPreferenceComponent

Parameters:

aPrefs - the application preferences

user - the user reference

getAcceleratorPreferencesKey

protected String getAcceleratorPreferencesKey()

Gets the accelerator preference key.

Returns:

the union of menu_accelerator key with attribute.

getFormName

public String getFormName()

Specified by:

getFormName in interface IParameterItem

setFormName

public void setFormName(String formName)

isDialog

public boolean isDialog()

Specified by:

isDialog in interface IParameterItem

setDialog

public void setDialog(boolean dialog)

getFormManagerName

public String getFormManagerName()

Specified by:

getFormManagerName in interface IParameterItem

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in interface IDynamicItem

setDynamic

public void setDynamic(boolean dynamic)