Package io.guise.framework.prototype

Class NavigateActionPrototype

java.lang.Object

com.globalmentor.beans.BoundPropertyObject

io.guise.framework.model.AbstractModel

io.guise.framework.model.DefaultLabelModel

io.guise.framework.model.DefaultInfoModel

io.guise.framework.prototype.AbstractPrototype

io.guise.framework.prototype.AbstractEnableablePrototype

io.guise.framework.prototype.AbstractActionPrototype

io.guise.framework.prototype.NavigateActionPrototype

All Implemented Interfaces:

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

public class NavigateActionPrototype
extends AbstractActionPrototype

Action prototype that knows how to navigate. The navigation destination can be updated.

Author:

Garret Wilson

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAVIGATION_URI_PROPERTY	The navigation URI bound property.

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface io.guise.framework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface io.guise.framework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface io.guise.framework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
NavigateActionPrototype()	Default constructor.
NavigateActionPrototype(com.globalmentor.net.URIPath navigationURIPath)	Navigation URI path constructor.
NavigateActionPrototype(java.lang.String label)	Label constructor.
NavigateActionPrototype(java.lang.String label, com.globalmentor.net.URIPath navigationURIPath)	Label and navigation URI path constructor.
NavigateActionPrototype(java.lang.String label, java.net.URI icon)	Label and icon constructor.
NavigateActionPrototype(java.lang.String label, java.net.URI icon, com.globalmentor.net.URIPath navigationURIPath)	Label, icon, and navigation URI path constructor.
NavigateActionPrototype(java.lang.String label, java.net.URI icon, java.net.URI navigationURI)	Label, icon, and navigation URI constructor.
NavigateActionPrototype(java.net.URI navigationURI)	Navigation URI constructor.

Method Summary

Modifier and Type	Method	Description
protected void	action(int force, int option)	Performs whatever is necessary.
java.net.URI	getNavigationURI()
void	setNavigationURI(java.net.URI newNavigationURI)	Sets the URI for navigation.
void	setNavigationURIPath(com.globalmentor.net.URIPath newNavigationURIPath)	Sets the URI path for navigation.

Methods inherited from class io.guise.framework.prototype.AbstractActionPrototype

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

Methods inherited from class io.guise.framework.prototype.AbstractEnableablePrototype

isEnabled, setEnabled

Methods inherited from class io.guise.framework.model.DefaultInfoModel

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

Methods inherited from class io.guise.framework.model.DefaultLabelModel

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

Methods inherited from class io.guise.framework.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 io.guise.framework.model.Enableable

isEnabled, setEnabled

Methods inherited from interface io.guise.framework.model.InfoModel

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

Methods inherited from interface io.guise.framework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

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

Field Detail

NAVIGATION_URI_PROPERTY

public static final java.lang.String NAVIGATION_URI_PROPERTY

The navigation URI bound property.

Constructor Detail

NavigateActionPrototype

public NavigateActionPrototype()

Default constructor.

NavigateActionPrototype

public NavigateActionPrototype(java.lang.String label)

Label constructor.

Parameters:

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

NavigateActionPrototype

public NavigateActionPrototype(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.

NavigateActionPrototype

public NavigateActionPrototype(java.net.URI navigationURI)

Navigation URI constructor.

Parameters:

navigationURI - The URI for navigation when the action occurs, or null if no navigation should occur.

NavigateActionPrototype

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

Label, icon, and navigation URI 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.

navigationURI - The URI for navigation when the action occurs, or null if no navigation should occur.

NavigateActionPrototype

public NavigateActionPrototype(com.globalmentor.net.URIPath navigationURIPath)

Navigation URI path constructor.

Parameters:

navigationURIPath - The URI path for navigation when the action occurs, or null if no navigation should occur.

NavigateActionPrototype

public NavigateActionPrototype(java.lang.String label,
                               com.globalmentor.net.URIPath navigationURIPath)

Label and navigation URI path constructor.

Parameters:

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

navigationURIPath - The URI path for navigation when the action occurs, or null if no navigation should occur.

NavigateActionPrototype

public NavigateActionPrototype(java.lang.String label,
                               java.net.URI icon,
                               com.globalmentor.net.URIPath navigationURIPath)

Label, icon, and navigation URI path 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.

navigationURIPath - The URI path for navigation when the action occurs, or null if no navigation should occur.

Method Detail

getNavigationURI

public java.net.URI getNavigationURI()

Returns:

The requested navigation URI.

setNavigationURI

public void setNavigationURI(java.net.URI newNavigationURI)

Sets the URI for navigation. This is a bound property.

Parameters:

newNavigationURI - The new URI for navigation.

See Also:

NAVIGATION_URI_PROPERTY

setNavigationURIPath

public void setNavigationURIPath(com.globalmentor.net.URIPath newNavigationURIPath)

Sets the URI path for navigation. This is a bound property.

Parameters:

newNavigationURIPath - The new URI path for navigation.

See Also:

NAVIGATION_URI_PROPERTY

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.