ch.uzh.ifi.attempto.preditor
Class MenuItem

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.button.AbstractButton
          nextapp.echo.app.Button
              ch.uzh.ifi.attempto.preditor.MenuItem

All Implemented Interfaces:

java.io.Serializable, nextapp.echo.app.RenderIdSupport

Direct Known Subclasses:

MenuEntry, SpecialMenuItem

public abstract class MenuItem
extends nextapp.echo.app.Button

This abstract class represents an item of a menu of the predictive editor. Each menu item contains the name of the menu group it belongs to.

Author:

Tobias Kuhn

See Also:

Serialized Form

Field Summary

Fields inherited from class nextapp.echo.app.button.AbstractButton

ACTION_LISTENERS_CHANGED_PROPERTY, INPUT_ACTION, PROPERTY_ALIGNMENT, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_DISABLED_BACKGROUND, PROPERTY_DISABLED_BACKGROUND_IMAGE, PROPERTY_DISABLED_BORDER, PROPERTY_DISABLED_FONT, PROPERTY_DISABLED_FOREGROUND, PROPERTY_DISABLED_ICON, PROPERTY_FOCUSED_BACKGROUND, PROPERTY_FOCUSED_BACKGROUND_IMAGE, PROPERTY_FOCUSED_BORDER, PROPERTY_FOCUSED_ENABLED, PROPERTY_FOCUSED_FONT, PROPERTY_FOCUSED_FOREGROUND, PROPERTY_FOCUSED_ICON, PROPERTY_HEIGHT, PROPERTY_ICON, PROPERTY_ICON_TEXT_MARGIN, PROPERTY_INSETS, PROPERTY_LINE_WRAP, PROPERTY_MODEL, PROPERTY_PRESSED_BACKGROUND, PROPERTY_PRESSED_BACKGROUND_IMAGE, PROPERTY_PRESSED_BORDER, PROPERTY_PRESSED_ENABLED, PROPERTY_PRESSED_FONT, PROPERTY_PRESSED_FOREGROUND, PROPERTY_PRESSED_ICON, PROPERTY_ROLLOVER_BACKGROUND, PROPERTY_ROLLOVER_BACKGROUND_IMAGE, PROPERTY_ROLLOVER_BORDER, PROPERTY_ROLLOVER_ENABLED, PROPERTY_ROLLOVER_FONT, PROPERTY_ROLLOVER_FOREGROUND, PROPERTY_ROLLOVER_ICON, PROPERTY_TEXT, PROPERTY_TEXT_ALIGNMENT, PROPERTY_TEXT_POSITION, PROPERTY_TOOL_TIP_TEXT, PROPERTY_WIDTH

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

MenuItem(java.lang.String menuGroup)
Initializes a new menu item.

Method Summary

boolean	equals(java.lang.Object obj)
protected abstract java.lang.String[]	getContent() This method is used to calculate the unique identifier.
java.lang.String	getMenuGroup() Returns the name of the menu group of this menu item.
java.lang.String	getMenuItemID() This method returns an identifier that is unique (within one instance of the predictive editor).
boolean	isHighlighted() Returns whether this menu item is highlighted or not.
protected void	recalculateID() This method should be called internally whenever something changed that has an influence on the identifier.
void	setColorShift(int colorShift) This methods sets the color shift that defines the color in which this menu item is to be displayed.
void	setHighlighted(boolean highlighted) This method determines whether the menu entry is highlighted or not.
protected void	updateStyle() This method sets the style according to whether or not this menu item is highlighted.

Methods inherited from class nextapp.echo.app.button.AbstractButton

addActionListener, doAction, fireActionPerformed, getActionCommand, getAlignment, getBackgroundImage, getBorder, getDisabledBackground, getDisabledBackgroundImage, getDisabledBorder, getDisabledFont, getDisabledForeground, getDisabledIcon, getFocusedBackground, getFocusedBackgroundImage, getFocusedBorder, getFocusedFont, getFocusedForeground, getFocusedIcon, getHeight, getIcon, getIconTextMargin, getInsets, getModel, getPressedBackground, getPressedBackgroundImage, getPressedBorder, getPressedFont, getPressedForeground, getPressedIcon, getRolloverBackground, getRolloverBackgroundImage, getRolloverBorder, getRolloverFont, getRolloverForeground, getRolloverIcon, getText, getTextAlignment, getTextPosition, getToolTipText, getWidth, hasActionListeners, isFocusedEnabled, isLineWrap, isPressedEnabled, isRolloverEnabled, isValidChild, processInput, removeActionListener, setActionCommand, setAlignment, setBackgroundImage, setBorder, setDisabledBackground, setDisabledBackgroundImage, setDisabledBorder, setDisabledFont, setDisabledForeground, setDisabledIcon, setFocusedBackground, setFocusedBackgroundImage, setFocusedBorder, setFocusedEnabled, setFocusedFont, setFocusedForeground, setFocusedIcon, setHeight, setIcon, setIconTextMargin, setInsets, setLineWrap, setModel, setPressedBackground, setPressedBackgroundImage, setPressedBorder, setPressedEnabled, setPressedFont, setPressedForeground, setPressedIcon, setRolloverBackground, setRolloverBackgroundImage, setRolloverBorder, setRolloverEnabled, setRolloverFont, setRolloverForeground, setRolloverIcon, setText, setTextAlignment, setTextPosition, setToolTipText, setWidth

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MenuItem

public MenuItem(java.lang.String menuGroup)

Initializes a new menu item.

Parameters:

menuGroup - The menu group to which this item should be assigned.

Method Detail

getMenuGroup

public java.lang.String getMenuGroup()

Returns the name of the menu group of this menu item.

Returns:

The name of the menu group.

getMenuItemID

public java.lang.String getMenuItemID()

This method returns an identifier that is unique (within one instance of the predictive editor).

Returns:

the identifier.

setHighlighted

public void setHighlighted(boolean highlighted)

This method determines whether the menu entry is highlighted or not. Hightlighted menu entries are displayed in bold font and are shown in front of non-highlighted menu entries in sorted lists.

Parameters:

highlighted - true if this entry should be highlighted.

isHighlighted

public boolean isHighlighted()

Returns whether this menu item is highlighted or not.

Returns:

true if this menu item is highlighted.

setColorShift

public void setColorShift(int colorShift)

This methods sets the color shift that defines the color in which this menu item is to be displayed.

Parameters:

colorShift - The color shift value.

See Also:

MenuCreator.getColorShift(java.lang.String)

recalculateID

protected void recalculateID()

This method should be called internally whenever something changed that has an influence on the identifier.

updateStyle

protected void updateStyle()

This method sets the style according to whether or not this menu item is highlighted.

getContent

protected abstract java.lang.String[] getContent()

This method is used to calculate the unique identifier.

Returns:

An array of strings that uniquely defines the menu item object.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object