CaptionButton Class

CaptionButton Class

This Package | All Packages 

Enum
  |
  +--CaptionButton
public final class CaptionButton
extends Enum

Defines that constants that you can pass to the Graphics.drawCaptionButton method. These constants determine the button's appearance.

Also see wfc.ui.Graphics

Fields
Name Description
CLOSE Draws the close "X" button.
HELP Draws the caption help button.
MAX
MAXIMIZE Draws the caption maximize button.
MIN
MINIMIZE Draws the caption minimize button.
RESTORE Draws the caption restore button.

Methods
Name Description
ensureValid(int value) Throws an exception if the given value is not supported by this class.
valid(int value) Retrieves a boolean value that indicates whether the specified value is supported by this class.

Fields

CaptionButton.CLOSE

Syntax
public static final int CLOSE;
Description
Draws the close "X" button.

CaptionButton.HELP

Syntax
public static final int HELP;
Description
Draws the caption help button.

CaptionButton.MAX

Syntax
public static final int MAX;
Description

CaptionButton.MAXIMIZE

Syntax
public static final int MAXIMIZE;
Description
Draws the caption maximize button.

CaptionButton.MIN

Syntax
public static final int MIN;
Description

CaptionButton.MINIMIZE

Syntax
public static final int MINIMIZE;
Description
Draws the caption minimize button.

CaptionButton.RESTORE

Syntax
public static final int RESTORE;
Description
Draws the caption restore button.

Methods

CaptionButton.ensureValid

Syntax
public static void ensureValid( int value );
Parameters
value
The value to check.
Description

Throws an exception if the given value is not supported by this class.

Exceptions

InvalidEnumArgument thrown if the specified constant is not supported by this class.

CaptionButton.valid

Syntax
public static boolean valid( int value );
Parameters
value
The value to check.
Return Value

Returns true if the value is valid; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the specified value is supported by this class.