Package org.pushingpixels.radiance.component.api.common.model

Class Command

java.lang.Object

org.pushingpixels.radiance.component.api.common.model.BaseCommand<CommandMenuContentModel>

org.pushingpixels.radiance.component.api.common.model.Command

All Implemented Interfaces:

ChangeAware, ContentModel, PropertyChangeAware

public class Command
extends BaseCommand<CommandMenuContentModel>

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 BaseProjection.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.Builder

Nested classes/interfaces inherited from class org.pushingpixels.radiance.component.api.common.model.BaseCommand

BaseCommand.BaseBuilder<T extends BaseCommand<MCM>,MCM extends BaseCommandMenuContentModel,B extends BaseCommand.BaseBuilder<T,MCM,B>>, BaseCommand.CommandActionPreview, BaseCommand.SecondaryLifecycle

Method Summary

Modifier and Type	Method	Description
static Command.Builder	builder()
CommandButtonProjection<Command>	project()
CommandButtonProjection<Command>	project(CommandButtonPresentationModel commandPresentation)
java.lang.String	toString()

Methods inherited from class org.pushingpixels.radiance.component.api.common.model.BaseCommand

addChangeListener, addPropertyChangeListener, checkConsistency, getAction, getActionPreview, getActionRichTooltip, getExtraText, getIconFactory, getSecondaryContentModel, getSecondaryLifecycle, getSecondaryRichTooltip, getTag, getText, getToggleGroupModel, hasSecondaryContent, isActionEnabled, isSecondaryEnabled, isToggle, isToggleSelected, removeChangeListener, removePropertyChangeListener, setAction, setActionEnabled, setActionPreview, setActionRichTooltip, setExtraText, setIconFactory, setSecondaryEnabled, setSecondaryRichTooltip, setTag, setText, setToggleSelected

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Command.Builder builder()

project

public CommandButtonProjection<Command> project()

project

public CommandButtonProjection<Command> project(CommandButtonPresentationModel commandPresentation)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object