Class CommandButtonPresentationState

java.lang.Object

org.pushingpixels.radiance.component.api.common.CommandButtonPresentationState

public abstract class CommandButtonPresentationState
extends Object

Presentation state for command buttons. In addition to a number of core presentation states provided by the static fields of this class, 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 final CommandButtonPresentationState	BIG	Big state.
static final CommandButtonPresentationState	BIG_FIT_TO_ICON	Fit-to-icon + big state
private String	displayName	Display name for this state.
static final CommandButtonPresentationState	MEDIUM	Medium state.
static final CommandButtonPresentationState	MEDIUM_FIT_TO_ICON	Fit-to-icon + medium state
private int	preferredIconSize	Preferred icon size for this state.
static final CommandButtonPresentationState	SMALL	Small state.
static final CommandButtonPresentationState	SMALL_FIT_TO_ICON	Fit-to-icon + small state
static final CommandButtonPresentationState	TILE	Tile state.
static final CommandButtonPresentationState	TILE_FIT_TO_ICON	Fit-to-icon + tile state

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandButtonPresentationState(String displayName, int preferredIconSize)	Creates a new command button presentation state.

Method Summary

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

Methods inherited from class Object

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

Field Details

BIG

public static final CommandButtonPresentationState BIG

Big state.

BIG_FIT_TO_ICON

public static final CommandButtonPresentationState BIG_FIT_TO_ICON

Fit-to-icon + big state

TILE

public static final CommandButtonPresentationState TILE

Tile state.

TILE_FIT_TO_ICON

public static final CommandButtonPresentationState TILE_FIT_TO_ICON

Fit-to-icon + tile state

MEDIUM

public static final CommandButtonPresentationState MEDIUM

Medium state.

MEDIUM_FIT_TO_ICON

public static final CommandButtonPresentationState MEDIUM_FIT_TO_ICON

Fit-to-icon + medium state

SMALL

public static final CommandButtonPresentationState SMALL

Small state.

SMALL_FIT_TO_ICON

public static final CommandButtonPresentationState SMALL_FIT_TO_ICON

Fit-to-icon + small state

preferredIconSize

private int preferredIconSize

Preferred icon size for this state.

See Also:

• CommandButtonPresentationState(String, int)
• getPreferredIconSize()

displayName

private String displayName

Display name for this state.

See Also:

• CommandButtonPresentationState(String, int)
• getDisplayName()

Constructor Details

CommandButtonPresentationState

protected CommandButtonPresentationState(String displayName,
 int preferredIconSize)

Creates a new command button presentation state.

Parameters:

displayName - Display name.

preferredIconSize - Preferred icon size.

Method Details

getDisplayName

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

Creates a layout manager for this state.

Returns:

A layout manager for this state.

toString

public String toString()

Overrides:

toString in class Object