Package org.pushingpixels.flamingo.api.common

Class CommandButtonPresentationState

java.lang.Object

org.pushingpixels.flamingo.api.common.CommandButtonPresentationState

public abstract class CommandButtonPresentationState
extends java.lang.Object

Presentation state for command buttons. This class provides a number of core presentation states, and it is possible to create additional custom states by using the protected constructor and implementing the relevant abstract methods.

Field Summary

Fields

Modifier and Type	Field	Description
static CommandButtonPresentationState	BIG	Big state.
static CommandButtonPresentationState	FIT_TO_ICON	Fit to icon state.
static CommandButtonPresentationState	MEDIUM	Medium state.
static CommandButtonPresentationState	SMALL	Small state.
static CommandButtonPresentationState	TILE	Tile state.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandButtonPresentationState(java.lang.String displayName, int preferredIconSize)	Creates a new element state.

Method Summary

Modifier and Type	Method	Description
abstract CommandButtonLayoutManager	createLayoutManager(AbstractCommandButton commandButton)	Creates a layout manager for the specified button.
java.lang.String	getDisplayName()	Returns the display name for this state.
int	getPreferredIconSize()	Returns the preferred icon size for this state.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIT_TO_ICON

public static final CommandButtonPresentationState FIT_TO_ICON

Fit to icon state.

BIG

public static final CommandButtonPresentationState BIG

Big state.

TILE

public static final CommandButtonPresentationState TILE

Tile state.

MEDIUM

public static final CommandButtonPresentationState MEDIUM

Medium state.

SMALL

public static final CommandButtonPresentationState SMALL

Small state.

Constructor Detail

CommandButtonPresentationState

protected CommandButtonPresentationState(java.lang.String displayName,
                                         int preferredIconSize)

Creates a new element state.

Parameters:

displayName - Display name.

preferredIconSize - Preferred icon size.

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns the display name for this state.

Returns:

The display name for this state.

See Also:

CommandButtonPresentationState(String, int)

getPreferredIconSize

public int getPreferredIconSize()

Returns the preferred icon size for this state.

Returns:

The preferred icon size for this state.

See Also:

CommandButtonPresentationState(String, int)

createLayoutManager

public abstract CommandButtonLayoutManager createLayoutManager(AbstractCommandButton commandButton)

Creates a layout manager for the specified button.

Parameters:

commandButton - Command button.

Returns:

A layout manager for the specified button.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object