com.jidesoft.document
Interface DocumentPane.DocumentTabColorProvider

Enclosing class:

DocumentPane

public static interface DocumentPane.DocumentTabColorProvider

An interface to provide colors for tab background and foreground of a Document.

Since:

3.5.5

Method Summary

Color	getBackgroundAt(int documentIndex) Gets the tab background for the document at the specified document.
Color	getForegroundAt(int documentIndex) Gets the tab foreground for the document at the specified document.
float	getGradientRatio(int documentIndex) Gets the gradient ratio.

Method Detail

getBackgroundAt

Color getBackgroundAt(int documentIndex)

Gets the tab background for the document at the specified document.

Parameters:

documentIndex - the index of the document

Returns:

the tab background for the specified document.

getForegroundAt

Color getForegroundAt(int documentIndex)

Gets the tab foreground for the document at the specified document.

Parameters:

documentIndex - the index of the document

Returns:

the tab foreground for the specified document.

getGradientRatio

float getGradientRatio(int documentIndex)

Gets the gradient ratio. We will use this ratio to provide another color in order to paint gradient.

Parameters:

documentIndex - the index of the document

Returns:

the gradient ratio. The value should be between 0 and 1. 0 will produce the darkest and color and 1 will produce the lightest color. 0.5 will provide the same color.