Package org.pushingpixels.flamingo.api.common.model

Class Command

java.lang.Object

org.pushingpixels.flamingo.api.common.model.Command

All Implemented Interfaces:

ChangeAware, ContentModel, PropertyChangeAware

Direct Known Subclasses:

ColorSelectorCommand

public class Command
extends java.lang.Object
implements ContentModel, ChangeAware, PropertyChangeAware

Encapsulates metadata for a single command. Use a new instance of Command.Builder to configure a new command, and Command.Builder.build() to build a command.

A command can be projected to screen (creating a visual representation of that command) using CommandButtonPresentationModel and CommandButtonProjection. Use project() for default presentation settings or project(CommandButtonPresentationModel) to customize presentation settings. Then use Projection.buildComponent() to get an instance of JCommandButton that can be added to the component hierarchy. Note that you can - and should - use the same Command instance and one or more CommandButtonPresentationModels if you need to have multiple instances (or projections) of the same command in your app UI. That way, changes in the command are propagated and synced across all those projections.

See Also:

CommandButtonPresentationModel, CommandButtonProjection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Command.BaseBuilder<T extends Command,B extends Command.BaseBuilder<T,B>>
static class	Command.Builder
static interface	Command.CommandActionPreview

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Command()

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(javax.swing.event.ChangeListener l)	Adds the specified change listener to track changes to the underlying source.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
static Command.Builder	builder()
CommandAction	getAction()
Command.CommandActionPreview	getActionPreview()
RichTooltip	getActionRichTooltip()
org.pushingpixels.neon.api.icon.ResizableIcon.Factory	getDisabledIconFactory()
java.lang.String	getExtraText()
org.pushingpixels.neon.api.icon.ResizableIcon.Factory	getIconFactory()
CommandMenuContentModel	getSecondaryContentModel()
RichTooltip	getSecondaryRichTooltip()
java.lang.String	getText()
CommandToggleGroupModel	getToggleGroupModel()
boolean	isActionEnabled()
boolean	isSecondaryEnabled()
boolean	isToggle()
boolean	isToggleSelected()
CommandButtonProjection<Command>	project()
CommandButtonProjection<Command>	project(CommandButtonPresentationModel commandPresentation)
void	removeChangeListener(javax.swing.event.ChangeListener l)	Removes the specified change listener from tracking changes to the underlying source.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
void	setAction(CommandAction actionListener)
void	setActionEnabled(boolean actionEnabled)
void	setActionPreview(Command.CommandActionPreview actionPreview)
void	setActionRichTooltip(RichTooltip actionRichTooltip)
void	setDisabledIconFactory(org.pushingpixels.neon.api.icon.ResizableIcon.Factory disabledIconFactory)
void	setExtraText(java.lang.String extraText)
void	setIconFactory(org.pushingpixels.neon.api.icon.ResizableIcon.Factory iconFactory)
void	setSecondaryEnabled(boolean secondaryEnabled)
void	setSecondaryRichTooltip(RichTooltip secondaryRichTooltip)
void	setText(java.lang.String text)
void	setToggleSelected(boolean isToggleSelected)

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

protected Command()

Method Detail

builder

public static Command.Builder builder()

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getIconFactory

public org.pushingpixels.neon.api.icon.ResizableIcon.Factory getIconFactory()

setIconFactory

public void setIconFactory(org.pushingpixels.neon.api.icon.ResizableIcon.Factory iconFactory)

getDisabledIconFactory

public org.pushingpixels.neon.api.icon.ResizableIcon.Factory getDisabledIconFactory()

setDisabledIconFactory

public void setDisabledIconFactory(org.pushingpixels.neon.api.icon.ResizableIcon.Factory disabledIconFactory)

getExtraText

public java.lang.String getExtraText()

setExtraText

public void setExtraText(java.lang.String extraText)

getAction

public CommandAction getAction()

setAction

public void setAction(CommandAction actionListener)

getActionRichTooltip

public RichTooltip getActionRichTooltip()

setActionRichTooltip

public void setActionRichTooltip(RichTooltip actionRichTooltip)

getSecondaryContentModel

public CommandMenuContentModel getSecondaryContentModel()

getSecondaryRichTooltip

public RichTooltip getSecondaryRichTooltip()

setSecondaryRichTooltip

public void setSecondaryRichTooltip(RichTooltip secondaryRichTooltip)

isActionEnabled

public boolean isActionEnabled()

setActionEnabled

public void setActionEnabled(boolean actionEnabled)

isSecondaryEnabled

public boolean isSecondaryEnabled()

setSecondaryEnabled

public void setSecondaryEnabled(boolean secondaryEnabled)

isToggle

public boolean isToggle()

isToggleSelected

public boolean isToggleSelected()

setToggleSelected

public void setToggleSelected(boolean isToggleSelected)

getToggleGroupModel

public CommandToggleGroupModel getToggleGroupModel()

getActionPreview

public Command.CommandActionPreview getActionPreview()

setActionPreview

public void setActionPreview(Command.CommandActionPreview actionPreview)

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

Description copied from interface: ChangeAware

Adds the specified change listener to track changes to the underlying source.

Specified by:

addChangeListener in interface ChangeAware

Parameters:

l - Change listener to add.

See Also:

ChangeAware.removeChangeListener(ChangeListener)

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

Description copied from interface: ChangeAware

Removes the specified change listener from tracking changes to the underlying source.

Specified by:

removeChangeListener in interface ChangeAware

Parameters:

l - Change listener to remove.

See Also:

ChangeAware.removeChangeListener(ChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface PropertyChangeAware

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface PropertyChangeAware

project

public CommandButtonProjection<Command> project()

project

public CommandButtonProjection<Command> project(CommandButtonPresentationModel commandPresentation)