org.lyra.Interface
Class Constants

java.lang.Object
  org.lyra.Interface.Constants

public final class Constants
extends java.lang.Object

Constants exists exclusively to provide a consistent set of values between classes. This in return makes it easier to maintain a consistent look and feel.

Version:

1.0.5, %Revision, 174%, %LastChangedDate, 27/10/12 3:33PM%

Author:

Martin Foster

Field Summary

private static int	ART_SIZE
private static int	DEF_VOLUME
static java.util.Map<java.lang.String,java.lang.String>	fileHelp Map that contains filenames for various help documents that may be accessed at any time.
static java.util.Map<java.lang.String,java.lang.String>	fileIcons Map that contains a list of all known icons for cleaner interfacing.
private static int	INDENT_SPACE
private static int	LABEL_SPACE
private static int	LABEL_WIDTH
private static int	NORMAL_SPACE
private static int	RATING_MAX
private static int	ROW_SPACE
private static int	SCREEN_BUFFER
private static int	SEARCH_BUFFER
private static int	SECT_SPACE
private static int	SMALL_SPACE
private static int	TIP_DISMISS
private static int	TIP_INITIAL
private static int	TIP_RESHOW
private static int	WIDGET_HEIGHT
private static int	WIDGET_WIDTH

Constructor Summary

Constants()

Method Summary

static int	getArtSize() Returns the single dimension used to display album art.
static int	getDefaultVolume() Returns the default volume level when missing information.
static int	getIndentGap() Space necessary to create an indentation gap.
static int	getLabelSpacer() Label width is used in the generation of table like structures as a way to enforce the space between a label and the associated interface element.
static int	getLabelWidth() Label width is used in the generation of table like structures as a way to enforce the width of labels for a consistent look and feel.
static int	getMaxRating() Returns the maximum number of stars a rating can have.
static int	getNormalGap() In certain circumstances we need additional spacers even if they are not directly attached to the above.
static int	getPaddingHeight() When generating table-like elements it becomes necessary to add in a bit of spacing.
static int	getPaddingWidth() When generating table-like elements it becomes necessary to add in a bit of spacing.
static int	getRowGap() Enforces the space between row elements when creating table like elements for display.
static int	getScreenBuffer() Screen buffer is a generic number in order to determine if certain windows may require a resize.
static int	getSearchBuffer() The JToolBar element used for the Search capability requires an additional spacing.
static int	getSectionGap() Gap which exists between various elements in order to provide a cleaner overall look and feel.
static int	getSmallGap() In certain circumstances we need additional spacers even if they are not directly attached to the above.
static int	getTipDismissDelay() Returns the dismissal delay value.
static int	getTipInitialDelay() Returns the initial delay value.
static int	getTipReshowDelay() Returns the reshow delay property.

Methods inherited from class java.lang.Object

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

Field Detail

LABEL_WIDTH

private static final int LABEL_WIDTH

See Also:

Constant Field Values

LABEL_SPACE

private static final int LABEL_SPACE

See Also:

Constant Field Values

ROW_SPACE

private static final int ROW_SPACE

See Also:

Constant Field Values

SECT_SPACE

private static final int SECT_SPACE

See Also:

Constant Field Values

WIDGET_HEIGHT

private static final int WIDGET_HEIGHT

See Also:

Constant Field Values

WIDGET_WIDTH

private static final int WIDGET_WIDTH

See Also:

Constant Field Values

NORMAL_SPACE

private static final int NORMAL_SPACE

See Also:

Constant Field Values

SMALL_SPACE

private static final int SMALL_SPACE

See Also:

Constant Field Values

INDENT_SPACE

private static final int INDENT_SPACE

See Also:

Constant Field Values

SCREEN_BUFFER

private static final int SCREEN_BUFFER

See Also:

Constant Field Values

TIP_INITIAL

private static final int TIP_INITIAL

See Also:

Constant Field Values

TIP_RESHOW

private static final int TIP_RESHOW

See Also:

Constant Field Values

TIP_DISMISS

private static final int TIP_DISMISS

See Also:

Constant Field Values

ART_SIZE

private static final int ART_SIZE

See Also:

Constant Field Values

RATING_MAX

private static final int RATING_MAX

See Also:

Constant Field Values

DEF_VOLUME

private static final int DEF_VOLUME

See Also:

Constant Field Values

SEARCH_BUFFER

private static final int SEARCH_BUFFER

See Also:

Constant Field Values

fileIcons

public static final java.util.Map<java.lang.String,java.lang.String> fileIcons

Map that contains a list of all known icons for cleaner interfacing. Provides a consistent and hopefully centrally modifiable section for filenames.

fileHelp

public static final java.util.Map<java.lang.String,java.lang.String> fileHelp

Map that contains filenames for various help documents that may be accessed at any time.

Constructor Detail

Constants

public Constants()

Method Detail

getLabelWidth

public static final int getLabelWidth()

Label width is used in the generation of table like structures as a way to enforce the width of labels for a consistent look and feel.

Returns:

Integer containing label width

getLabelSpacer

public static final int getLabelSpacer()

Label width is used in the generation of table like structures as a way to enforce the space between a label and the associated interface element.

Returns:

Integer containing space between label and elements.

getRowGap

public static final int getRowGap()

Enforces the space between row elements when creating table like elements for display.

Returns:

Integer containing gap between rows.

getSectionGap

public static final int getSectionGap()

Gap which exists between various elements in order to provide a cleaner overall look and feel.

Returns:

Gap that exists between sections.

getPaddingHeight

public static final int getPaddingHeight()

When generating table-like elements it becomes necessary to add in a bit of spacing. This provides the height padding.

Returns:

Height padding to append.

getPaddingWidth

public static final int getPaddingWidth()

When generating table-like elements it becomes necessary to add in a bit of spacing. This provides the width padding.

Returns:

Width padding to append.

getSmallGap

public static final int getSmallGap()

In certain circumstances we need additional spacers even if they are not directly attached to the above. This provides a general number.

Returns:

Integer containing a small spacer.

getNormalGap

public static final int getNormalGap()

In certain circumstances we need additional spacers even if they are not directly attached to the above. This provides a general number.

Returns:

Integer containing general spacer.

getIndentGap

public static final int getIndentGap()

Space necessary to create an indentation gap. Used mostly when lining up against an image.

Returns:

Integer containing indentation gap.

getScreenBuffer

public static final int getScreenBuffer()

Screen buffer is a generic number in order to determine if certain windows may require a resize. Due either to window dressing or to user interface elements such as a status bar.

Returns:

Integer containing a generic screen buffer for UI elements.

getTipInitialDelay

public static final int getTipInitialDelay()

Returns the initial delay value.

Returns:

An integer representing the initial delay value, in milliseconds.

getTipReshowDelay

public static final int getTipReshowDelay()

Returns the reshow delay property.

Returns:

Integer for re-shown delay property.

getTipDismissDelay

public static final int getTipDismissDelay()

Returns the dismissal delay value.

Returns:

An integer representing the dismissal delay value, in milliseconds.

getArtSize

public static int getArtSize()

Returns the single dimension used to display album art. Album art covers are assumed to be square, hence the singular value.

Returns:

Integer marking width and height.

getMaxRating

public static int getMaxRating()

Returns the maximum number of stars a rating can have.

Returns:

Integer containing the maximum number a rating can have.

getDefaultVolume

public static int getDefaultVolume()

Returns the default volume level when missing information.

Returns:

Integer containing the default volume.

getSearchBuffer

public static int getSearchBuffer()

The JToolBar element used for the Search capability requires an additional spacing.

Returns:

Integer containing the buffer to add to the preferred size.