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

Class CommandButtonPresentationModel

java.lang.Object

org.pushingpixels.flamingo.api.common.model.CommandButtonPresentationModel

All Implemented Interfaces:

ImmutablePresentationModel, PresentationModel

public class CommandButtonPresentationModel
extends java.lang.Object
implements ImmutablePresentationModel

Encapsulates presentation metadata for displaying commands as buttons. Use a new instance of CommandButtonPresentationModel.Builder to configure a new presentation, and CommandButtonPresentationModel.Builder.build() to build a presentation.

Note that you can use the same CommandButtonPresentationModel instance on multiple calls to Command.project(CommandButtonPresentationModel). Use overlayWith(Overlay) to create a new presentation instance that overlays the presentation configuration with values set on the passed CommandButtonPresentationModel.Overlay object.

See Also:

Command, CommandButtonProjection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandButtonPresentationModel.Builder
static class	CommandButtonPresentationModel.Overlay
static class	CommandButtonPresentationModel.PopupHorizontalGravity	Popup horizontal gravity.
static class	CommandButtonPresentationModel.PopupOrientationKind	Orientation kind for the popup.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_AUTO_REPEAT_INITIAL_INTERVAL_MS
static int	DEFAULT_AUTO_REPEAT_SUBSEQUENT_INTERVAL_MS

Method Summary

Modifier and Type	Method	Description
static CommandButtonPresentationModel.Builder	builder()
java.lang.String	getActionKeyTip()
int	getAutoRepeatInitialInterval()
int	getAutoRepeatSubsequentInterval()
int	getHorizontalAlignment()
double	getHorizontalGapScaleFactor()
java.lang.Integer	getIconDimension()
CommandButtonPresentationModel.PopupHorizontalGravity	getPopupHorizontalGravity()
java.lang.String	getPopupKeyTip()
AbstractPopupMenuPresentationModel	getPopupMenuPresentationModel()
CommandButtonPresentationModel.PopupOrientationKind	getPopupOrientationKind()
CommandButtonPresentationState	getPresentationState()
double	getVerticalGapScaleFactor()
boolean	hasAutoRepeatIntervalsSet()
boolean	isAutoRepeatAction()
boolean	isFireActionOnPress()
boolean	isFireActionOnRollover()
boolean	isFlat()
boolean	isFocusable()
boolean	isMenu()
boolean	isTextClickAction()
boolean	isTextClickPopup()
boolean	isToDismissPopupsOnActivation()
static CommandButtonPresentationModel.Overlay	overlay()
CommandButtonPresentationModel	overlayWith(CommandButtonPresentationModel.Overlay overlay)
static CommandButtonPresentationModel	withDefaults()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AUTO_REPEAT_INITIAL_INTERVAL_MS

public static final int DEFAULT_AUTO_REPEAT_INITIAL_INTERVAL_MS

See Also:

Constant Field Values

DEFAULT_AUTO_REPEAT_SUBSEQUENT_INTERVAL_MS

public static final int DEFAULT_AUTO_REPEAT_SUBSEQUENT_INTERVAL_MS

See Also:

Constant Field Values

Method Detail

overlayWith

public CommandButtonPresentationModel overlayWith(CommandButtonPresentationModel.Overlay overlay)

withDefaults

public static CommandButtonPresentationModel withDefaults()

builder

public static CommandButtonPresentationModel.Builder builder()

overlay

public static CommandButtonPresentationModel.Overlay overlay()

getPresentationState

public CommandButtonPresentationState getPresentationState()

isFlat

public boolean isFlat()

isFocusable

public boolean isFocusable()

getHorizontalAlignment

public int getHorizontalAlignment()

getHorizontalGapScaleFactor

public double getHorizontalGapScaleFactor()

getVerticalGapScaleFactor

public double getVerticalGapScaleFactor()

getIconDimension

public java.lang.Integer getIconDimension()

getPopupOrientationKind

public CommandButtonPresentationModel.PopupOrientationKind getPopupOrientationKind()

getPopupHorizontalGravity

public CommandButtonPresentationModel.PopupHorizontalGravity getPopupHorizontalGravity()

isMenu

public boolean isMenu()

isToDismissPopupsOnActivation

public boolean isToDismissPopupsOnActivation()

getPopupMenuPresentationModel

public AbstractPopupMenuPresentationModel getPopupMenuPresentationModel()

getActionKeyTip

public java.lang.String getActionKeyTip()

getPopupKeyTip

public java.lang.String getPopupKeyTip()

isTextClickAction

public boolean isTextClickAction()

isTextClickPopup

public boolean isTextClickPopup()

isFireActionOnRollover

public boolean isFireActionOnRollover()

isFireActionOnPress

public boolean isFireActionOnPress()

isAutoRepeatAction

public boolean isAutoRepeatAction()

hasAutoRepeatIntervalsSet

public boolean hasAutoRepeatIntervalsSet()

getAutoRepeatInitialInterval

public int getAutoRepeatInitialInterval()

getAutoRepeatSubsequentInterval

public int getAutoRepeatSubsequentInterval()