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

Class CommandButtonPresentationModel

java.lang.Object

org.pushingpixels.radiance.component.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.FireActionTrigger
static class	CommandButtonPresentationModel.Overlay
static class	CommandButtonPresentationModel.TextClick

Field Summary

Fields

Modifier and Type	Field	Description
static java.awt.Insets	COMPACT_BUTTON_CONTENT_PADDING
static int	DEFAULT_AUTO_REPEAT_INITIAL_INTERVAL_MS
static int	DEFAULT_AUTO_REPEAT_SUBSEQUENT_INTERVAL_MS
static double	DEFAULT_GAP_SCALE_FACTOR
static int	DEFAULT_HORIZONTAL_ALIGNMENT
static java.awt.Insets	WIDE_BUTTON_CONTENT_PADDING

Method Summary

Modifier and Type	Method	Description
static CommandButtonPresentationModel.Builder	builder()
java.lang.String	getActionKeyTip()
RichTooltipPresentationModel	getActionRichTooltipPresentationModel()
org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy	getActiveIconFilterStrategy()
int	getAutoRepeatInitialInterval()
int	getAutoRepeatSubsequentInterval()
org.pushingpixels.radiance.theming.api.RadianceThemingSlices.BackgroundAppearanceStrategy	getBackgroundAppearanceStrategy()
java.awt.Insets	getContentPadding()
org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy	getDisabledIconFilterStrategy()
org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy	getEnabledIconFilterStrategy()
CommandButtonPresentationModel.FireActionTrigger	getFireActionTrigger()
int	getHorizontalAlignment()
double	getHorizontalGapScaleFactor()
java.lang.Integer	getIconDimension()
java.lang.String	getPopupKeyTip()
AbstractPopupMenuPresentationModel	getPopupMenuPresentationModel()
org.pushingpixels.radiance.theming.api.RadianceThemingSlices.PopupPlacementStrategy	getPopupPlacementStrategy()
RichTooltipPresentationModel	getPopupRichTooltipPresentationModel()
CommandButtonPresentationState	getPresentationState()
CommandButtonPresentationModel.TextClick	getTextClick()
double	getVerticalGapScaleFactor()
boolean	hasAutoRepeatIntervalsSet()
boolean	isAutoRepeatAction()
boolean	isFocusable()
boolean	isMenu()
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_HORIZONTAL_ALIGNMENT

public static final int DEFAULT_HORIZONTAL_ALIGNMENT

See Also:

Constant Field Values

DEFAULT_GAP_SCALE_FACTOR

public static final double DEFAULT_GAP_SCALE_FACTOR

See Also:

Constant Field Values

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

WIDE_BUTTON_CONTENT_PADDING

public static final java.awt.Insets WIDE_BUTTON_CONTENT_PADDING

COMPACT_BUTTON_CONTENT_PADDING

public static final java.awt.Insets COMPACT_BUTTON_CONTENT_PADDING

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()

getBackgroundAppearanceStrategy

public org.pushingpixels.radiance.theming.api.RadianceThemingSlices.BackgroundAppearanceStrategy getBackgroundAppearanceStrategy()

isFocusable

public boolean isFocusable()

getHorizontalAlignment

public int getHorizontalAlignment()

getContentPadding

public java.awt.Insets getContentPadding()

getHorizontalGapScaleFactor

public double getHorizontalGapScaleFactor()

getVerticalGapScaleFactor

public double getVerticalGapScaleFactor()

getIconDimension

public java.lang.Integer getIconDimension()

getActiveIconFilterStrategy

public org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy getActiveIconFilterStrategy()

getEnabledIconFilterStrategy

public org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy getEnabledIconFilterStrategy()

getDisabledIconFilterStrategy

public org.pushingpixels.radiance.theming.api.RadianceThemingSlices.IconFilterStrategy getDisabledIconFilterStrategy()

getPopupPlacementStrategy

public org.pushingpixels.radiance.theming.api.RadianceThemingSlices.PopupPlacementStrategy getPopupPlacementStrategy()

isMenu

public boolean isMenu()

isToDismissPopupsOnActivation

public boolean isToDismissPopupsOnActivation()

getPopupMenuPresentationModel

public AbstractPopupMenuPresentationModel getPopupMenuPresentationModel()

getActionKeyTip

public java.lang.String getActionKeyTip()

getPopupKeyTip

public java.lang.String getPopupKeyTip()

getTextClick

public CommandButtonPresentationModel.TextClick getTextClick()

getFireActionTrigger

public CommandButtonPresentationModel.FireActionTrigger getFireActionTrigger()

isAutoRepeatAction

public boolean isAutoRepeatAction()

hasAutoRepeatIntervalsSet

public boolean hasAutoRepeatIntervalsSet()

getAutoRepeatInitialInterval

public int getAutoRepeatInitialInterval()

getAutoRepeatSubsequentInterval

public int getAutoRepeatSubsequentInterval()

getActionRichTooltipPresentationModel

public RichTooltipPresentationModel getActionRichTooltipPresentationModel()

getPopupRichTooltipPresentationModel

public RichTooltipPresentationModel getPopupRichTooltipPresentationModel()