Package org.pushingpixels.flamingo.api.common

Class FlamingoCommand

java.lang.Object

org.pushingpixels.flamingo.api.common.FlamingoCommand

Direct Known Subclasses:

RibbonApplicationMenuPrimaryCommand

public class FlamingoCommand
extends java.lang.Object

Encapsulates metadata associated with a single command. Use a new instance of FlamingoCommand.FlamingoCommandBuilder to configure a new command, and FlamingoCommand.FlamingoCommandBuilder.build() to build a command. Note that while buildButton() can be used to directly build the visual representation of a command, commands represented by this class are passed to various APIs on the JRibbon and JRibbonBand to construct and modify the ribbon content. Use setEnabled(boolean) to control the enabled state of the command and, by extension, its visual representation that you acquire from the buildButton() call.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlamingoCommand.BaseFlamingoCommandBuilder<T extends FlamingoCommand,B extends FlamingoCommand.BaseFlamingoCommandBuilder>
static class	FlamingoCommand.FlamingoCommandBuilder
static class	FlamingoCommand.FlamingoCommandToggleGroup

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlamingoCommand()

Method Summary

Modifier and Type	Method	Description
AbstractCommandButton	buildButton()
AbstractCommandButton	buildMenuButton()
protected void	checkConsistency()
java.awt.event.ActionListener	getAction()
java.lang.String	getActionKeyTip()
RichTooltip	getActionRichTooltip()
int	getAutoRepeatInitialInterval()
int	getAutoRepeatSubsequentInterval()
org.pushingpixels.neon.icon.ResizableIcon	getDisabledIcon()
java.lang.String	getExtraText()
org.pushingpixels.neon.icon.ResizableIcon	getIcon()
PopupPanelCallback	getPopupCallback()
java.lang.String	getPopupKeyTip()
JCommandButton.CommandButtonPopupOrientationKind	getPopupOrientationKind()
RichTooltip	getPopupRichTooltip()
java.lang.String	getTitle()
FlamingoCommand.FlamingoCommandToggleGroup	getToggleGroup()
protected boolean	hasAction()
protected boolean	hasPopup()
boolean	isAutoRepeatAction()
boolean	isEnabled()
boolean	isFireActionOnRollover()
boolean	isTitleClickAction()
boolean	isTitleClickPopup()
boolean	isToggle()
boolean	isToggleSelected()
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlamingoCommand

protected FlamingoCommand()

Method Detail

checkConsistency

protected void checkConsistency()

getTitle

public java.lang.String getTitle()

getIcon

public org.pushingpixels.neon.icon.ResizableIcon getIcon()

getDisabledIcon

public org.pushingpixels.neon.icon.ResizableIcon getDisabledIcon()

getExtraText

public java.lang.String getExtraText()

getAction

public java.awt.event.ActionListener getAction()

getActionRichTooltip

public RichTooltip getActionRichTooltip()

getActionKeyTip

public java.lang.String getActionKeyTip()

getPopupCallback

public PopupPanelCallback getPopupCallback()

getPopupRichTooltip

public RichTooltip getPopupRichTooltip()

getPopupKeyTip

public java.lang.String getPopupKeyTip()

getPopupOrientationKind

public JCommandButton.CommandButtonPopupOrientationKind getPopupOrientationKind()

isTitleClickAction

public boolean isTitleClickAction()

isTitleClickPopup

public boolean isTitleClickPopup()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isToggle

public boolean isToggle()

isToggleSelected

public boolean isToggleSelected()

getToggleGroup

public FlamingoCommand.FlamingoCommandToggleGroup getToggleGroup()

isAutoRepeatAction

public boolean isAutoRepeatAction()

getAutoRepeatInitialInterval

public int getAutoRepeatInitialInterval()

getAutoRepeatSubsequentInterval

public int getAutoRepeatSubsequentInterval()

isFireActionOnRollover

public boolean isFireActionOnRollover()

hasAction

protected boolean hasAction()

hasPopup

protected boolean hasPopup()

buildButton

public AbstractCommandButton buildButton()

buildMenuButton

public AbstractCommandButton buildMenuButton()