com.guiseframework.prototype
Class MenuPrototype

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.model.AbstractModel
          com.guiseframework.model.DefaultLabelModel
              com.guiseframework.model.DefaultInfoModel
                  com.guiseframework.prototype.AbstractPrototype
                      com.guiseframework.prototype.AbstractEnableablePrototype
                          com.guiseframework.prototype.AbstractActionPrototype
                              com.guiseframework.prototype.MenuPrototype

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, ActionListenable, ActionModel, Enableable, InfoModel, LabelModel, Model, ActionPrototype, Prototype

public class MenuPrototype
extends AbstractActionPrototype

Contains prototype information for a menu.

Author:

Garret Wilson

Field Summary

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface com.guiseframework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface com.guiseframework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Constructor Summary

MenuPrototype()
Default constructor.

MenuPrototype(java.lang.String label)
Label constructor.

MenuPrototype(java.lang.String label, java.net.URI icon)
Label and icon constructor.

Method Summary

protected void

action(int force, int option) Performs whatever is necessary.

Methods inherited from class com.guiseframework.prototype.AbstractActionPrototype

addActionListener, fireActionPerformed, fireActionPerformed, getActionListeners, performAction, performAction, removeActionListener

Methods inherited from class com.guiseframework.prototype.AbstractEnableablePrototype

isEnabled, setEnabled

Methods inherited from class com.guiseframework.model.DefaultInfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from class com.guiseframework.model.DefaultLabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType, toString

Methods inherited from class com.guiseframework.model.AbstractModel

getEventListenerManager, getPlainText

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.guiseframework.model.Enableable

isEnabled, setEnabled

Methods inherited from interface com.guiseframework.model.InfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from interface com.guiseframework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Detail

MenuPrototype

public MenuPrototype()

Default constructor.

MenuPrototype

public MenuPrototype(java.lang.String label)

Label constructor.

Parameters:

label - The text of the label, or null if there should be no label.

MenuPrototype

public MenuPrototype(java.lang.String label,
                     java.net.URI icon)

Label and icon constructor.

Parameters:

label - The text of the label, or null if there should be no label.

icon - The icon URI, which may be a resource URI, or null if there is no icon URI.

Method Detail

action

protected void action(int force,
                      int option)

Description copied from class: AbstractActionPrototype

Performs whatever is necessary. This method is guaranteed to be called before any action event is fired to any listeners.

Specified by:

action in class AbstractActionPrototype

Parameters:

force - The zero-based force, such as 0 for no force or 1 for an action initiated by from a mouse single click.

option - The zero-based option, such as 0 for an event initiated by a mouse left button click or 1 for an event initiaged by a mouse right button click.