Package docking.widgets.fieldpanel.internal

Class EmptyFieldBackgroundColorManager

java.lang.Object

docking.widgets.fieldpanel.internal.EmptyFieldBackgroundColorManager

All Implemented Interfaces:

FieldBackgroundColorManager

public class EmptyFieldBackgroundColorManager
extends java.lang.Object
implements FieldBackgroundColorManager

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.List<Highlight>	EMPTY_HIGHLIGHT_LIST
static FieldBackgroundColorManager	EMPTY_INSTANCE

Method Summary

Modifier and Type	Method	Description
java.awt.Color	getBackgroundColor()	Returns the overall background color for the entire field.
java.awt.Color	getPaddingColor(int padIndex)	Returns the color for the right or left padding within the field.
java.util.List<Highlight>	getSelectionHighlights(int row)	Return a list of highlights (background colors ranges) for a given row of text in the field.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_INSTANCE

public static final FieldBackgroundColorManager EMPTY_INSTANCE

EMPTY_HIGHLIGHT_LIST

public static final java.util.List<Highlight> EMPTY_HIGHLIGHT_LIST

Method Detail

getSelectionHighlights

public java.util.List<Highlight> getSelectionHighlights(int row)

Description copied from interface: FieldBackgroundColorManager

Return a list of highlights (background colors ranges) for a given row of text in the field.

Specified by:

getSelectionHighlights in interface FieldBackgroundColorManager

Parameters:

row - the row for which to get a list of highlights.

Returns:

a list of highlights for the row.

getBackgroundColor

public java.awt.Color getBackgroundColor()

Description copied from interface: FieldBackgroundColorManager

Returns the overall background color for the entire field. If the field is totally, selected, then this color will be the selection color. If the field is highlighted,then the color will be the highlight color. If both, then the color will be the combined color. If the color is the same the overall background color of the layout containing this field, then null will be returned to indicate that the background color for this field does not need to be painted

Specified by:

getBackgroundColor in interface FieldBackgroundColorManager

Returns:

the background color for this field or null if it is the same as the background for the entire layout.

getPaddingColor

public java.awt.Color getPaddingColor(int padIndex)

Description copied from interface: FieldBackgroundColorManager

Returns the color for the right or left padding within the field. The padding is difference of the width of the field and the width of the text being displayed. Most fields pad to the right, but a few pad to the left.

Specified by:

getPaddingColor in interface FieldBackgroundColorManager

Parameters:

padIndex - either 0 or 1 to get left padding or right padding respectively.

Returns:

the color for either the right or left padding.