org.eclipse.swt.custom

Class CTabFolderRenderer

java.lang.Object

org.eclipse.swt.custom.CTabFolderRenderer

public class CTabFolderRenderer
extends java.lang.Object

Instances of this class provide all of the measuring and drawing functionality required by CTabFolder. This class can be subclassed in order to customize the look of a CTabFolder.

Since:

3.6

See Also:

Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	BORDER1_COLOR
(package private) static int[]	BOTTOM_LEFT_CORNER
(package private) static int[]	BOTTOM_LEFT_CORNER_BORDERLESS
(package private) static int[]	BOTTOM_RIGHT_CORNER
(package private) static int[]	BOTTOM_RIGHT_CORNER_BORDERLESS
(package private) static int	BUTTON_BORDER
(package private) static int	BUTTON_FILL
(package private) static int	BUTTON_SIZE
(package private) static int	BUTTON_TRIM
(package private) static RGB	CLOSE_FILL
(package private) int[]	curve
(package private) int	curveIndent
(package private) int	curveWidth
(package private) static java.lang.String	ELLIPSIS
(package private) Color	fillColor
(package private) static int	FLAGS
(package private) static int	INTERNAL_SPACING
(package private) static int	ITEM_BOTTOM_MARGIN
(package private) static int	ITEM_LEFT_MARGIN
(package private) static int	ITEM_RIGHT_MARGIN
(package private) static int	ITEM_TOP_MARGIN
(package private) Color	lastBorderColor
(package private) int	lastTabHeight
static int	MINIMUM_SIZE
protected CTabFolder	parent
static int	PART_BACKGROUND
static int	PART_BODY
static int	PART_BORDER
static int	PART_CHEVRON_BUTTON
static int	PART_CLOSE_BUTTON
static int	PART_HEADER
static int	PART_MAX_BUTTON
static int	PART_MIN_BUTTON
(package private) Color	selectedInnerColor
(package private) Color	selectedOuterColor
(package private) Color	selectionHighlightGradientBegin
(package private) Color[]	selectionHighlightGradientColorsCache
(package private) static int[]	SIMPLE_BOTTOM_LEFT_CORNER
(package private) static int[]	SIMPLE_BOTTOM_LEFT_CORNER_BORDERLESS
(package private) static int[]	SIMPLE_BOTTOM_RIGHT_CORNER
(package private) static int[]	SIMPLE_BOTTOM_RIGHT_CORNER_BORDERLESS
(package private) static int[]	SIMPLE_TOP_LEFT_CORNER
(package private) static int[]	SIMPLE_TOP_LEFT_CORNER_BORDERLESS
(package private) static int[]	SIMPLE_TOP_RIGHT_CORNER
(package private) static int[]	SIMPLE_TOP_RIGHT_CORNER_BORDERLESS
(package private) static int[]	SIMPLE_UNSELECTED_INNER_CORNER
(package private) Color	tabAreaColor
(package private) static int[]	TOP_LEFT_CORNER
(package private) static int[]	TOP_LEFT_CORNER_BORDERLESS
(package private) static int[]	TOP_LEFT_CORNER_HILITE
(package private) static int[]	TOP_RIGHT_CORNER
(package private) static int[]	TOP_RIGHT_CORNER_BORDERLESS
(package private) int[]	topCurveHighlightEnd
(package private) int[]	topCurveHighlightStart

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CTabFolderRenderer(CTabFolder parent) Constructs a new instance of this class given its parent.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	antialias(int[] shape, Color innerColor, Color outerColor, GC gc)
protected Point	computeSize(int part, int state, GC gc, int wHint, int hHint) Returns the preferred size of a part.
protected Rectangle	computeTrim(int part, int state, int x, int y, int width, int height) Given a desired client area for the part (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.
(package private) void	createAntialiasColors()
(package private) void	createSelectionHighlightGradientColors(Color start)
protected void	dispose() Dispose of any operating system resources associated with the renderer.
(package private) void	disposeAntialiasColors()
(package private) void	disposeSelectionHighlightGradientColors()
protected void	draw(int part, int state, Rectangle bounds, GC gc) Draw a specified part of the CTabFolder using the provided bounds and GC.
(package private) void	drawBackground(GC gc, int[] shape, boolean selected)
(package private) void	drawBackground(GC gc, int[] shape, int x, int y, int width, int height, Color defaultBackground, Image image, Color[] colors, int[] percents, boolean vertical)
(package private) void	drawBackground(GC gc, Rectangle bounds, int state)
(package private) void	drawBody(GC gc, Rectangle bounds, int state)
(package private) void	drawBorder(GC gc, int[] shape)
(package private) void	drawChevron(GC gc, Rectangle chevronRect, int chevronImageState)
(package private) void	drawClose(GC gc, Rectangle closeRect, int closeImageState)
(package private) void	drawHighlight(GC gc, Rectangle bounds, int state, int rightEdge)
(package private) void	drawLeftUnselectedBorder(GC gc, Rectangle bounds, int state)
(package private) void	drawMaximize(GC gc, Rectangle maxRect, int maxImageState)
(package private) void	drawMinimize(GC gc, Rectangle minRect, int minImageState)
(package private) void	drawRightUnselectedBorder(GC gc, Rectangle bounds, int state)
(package private) void	drawSelected(int itemIndex, GC gc, Rectangle bounds, int state)
(package private) void	drawTabArea(GC gc, Rectangle bounds, int state)
(package private) void	drawUnselected(int index, GC gc, Rectangle bounds, int state)
(package private) void	fillRegion(GC gc, Region region)
(package private) Color	getFillColor()
(package private) boolean	isSelectionHighlightColorsCacheHit(Color start)
(package private) void	setSelectionHighlightGradientColor(Color start)
(package private) java.lang.String	shortenText(GC gc, java.lang.String text, int width)
(package private) java.lang.String	shortenText(GC gc, java.lang.String text, int width, java.lang.String ellipses)
(package private) void	updateCurves()
(package private) boolean	useEllipses()

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected CTabFolder parent

curve

int[] curve

topCurveHighlightStart

int[] topCurveHighlightStart

topCurveHighlightEnd

int[] topCurveHighlightEnd

curveWidth

int curveWidth

curveIndent

int curveIndent

lastTabHeight

int lastTabHeight

fillColor

Color fillColor

selectionHighlightGradientBegin

Color selectionHighlightGradientBegin

selectionHighlightGradientColorsCache

Color[] selectionHighlightGradientColorsCache

selectedOuterColor

Color selectedOuterColor

selectedInnerColor

Color selectedInnerColor

tabAreaColor

Color tabAreaColor

lastBorderColor

Color lastBorderColor

TOP_LEFT_CORNER_HILITE

static final int[] TOP_LEFT_CORNER_HILITE

TOP_LEFT_CORNER

static final int[] TOP_LEFT_CORNER

TOP_RIGHT_CORNER

static final int[] TOP_RIGHT_CORNER

BOTTOM_LEFT_CORNER

static final int[] BOTTOM_LEFT_CORNER

BOTTOM_RIGHT_CORNER

static final int[] BOTTOM_RIGHT_CORNER

SIMPLE_TOP_LEFT_CORNER

static final int[] SIMPLE_TOP_LEFT_CORNER

SIMPLE_TOP_RIGHT_CORNER

static final int[] SIMPLE_TOP_RIGHT_CORNER

SIMPLE_BOTTOM_LEFT_CORNER

static final int[] SIMPLE_BOTTOM_LEFT_CORNER

SIMPLE_BOTTOM_RIGHT_CORNER

static final int[] SIMPLE_BOTTOM_RIGHT_CORNER

SIMPLE_UNSELECTED_INNER_CORNER

static final int[] SIMPLE_UNSELECTED_INNER_CORNER

TOP_LEFT_CORNER_BORDERLESS

static final int[] TOP_LEFT_CORNER_BORDERLESS

TOP_RIGHT_CORNER_BORDERLESS

static final int[] TOP_RIGHT_CORNER_BORDERLESS

BOTTOM_LEFT_CORNER_BORDERLESS

static final int[] BOTTOM_LEFT_CORNER_BORDERLESS

BOTTOM_RIGHT_CORNER_BORDERLESS

static final int[] BOTTOM_RIGHT_CORNER_BORDERLESS

SIMPLE_TOP_LEFT_CORNER_BORDERLESS

static final int[] SIMPLE_TOP_LEFT_CORNER_BORDERLESS

SIMPLE_TOP_RIGHT_CORNER_BORDERLESS

static final int[] SIMPLE_TOP_RIGHT_CORNER_BORDERLESS

SIMPLE_BOTTOM_LEFT_CORNER_BORDERLESS

static final int[] SIMPLE_BOTTOM_LEFT_CORNER_BORDERLESS

SIMPLE_BOTTOM_RIGHT_CORNER_BORDERLESS

static final int[] SIMPLE_BOTTOM_RIGHT_CORNER_BORDERLESS

CLOSE_FILL

static final RGB CLOSE_FILL

BUTTON_SIZE

static final int BUTTON_SIZE

See Also:

Constant Field Values

BUTTON_TRIM

static final int BUTTON_TRIM

See Also:

Constant Field Values

BUTTON_BORDER

static final int BUTTON_BORDER

See Also:

Constant Field Values

BUTTON_FILL

static final int BUTTON_FILL

See Also:

Constant Field Values

BORDER1_COLOR

static final int BORDER1_COLOR

See Also:

Constant Field Values

ITEM_TOP_MARGIN

static final int ITEM_TOP_MARGIN

See Also:

Constant Field Values

ITEM_BOTTOM_MARGIN

static final int ITEM_BOTTOM_MARGIN

See Also:

Constant Field Values

ITEM_LEFT_MARGIN

static final int ITEM_LEFT_MARGIN

See Also:

Constant Field Values

ITEM_RIGHT_MARGIN

static final int ITEM_RIGHT_MARGIN

See Also:

Constant Field Values

INTERNAL_SPACING

static final int INTERNAL_SPACING

See Also:

Constant Field Values

FLAGS

static final int FLAGS

See Also:

Constant Field Values

ELLIPSIS

static final java.lang.String ELLIPSIS

See Also:

Constant Field Values

PART_BODY

public static final int PART_BODY

See Also:

Constant Field Values

PART_HEADER

public static final int PART_HEADER

See Also:

Constant Field Values

PART_BORDER

public static final int PART_BORDER

See Also:

Constant Field Values

PART_BACKGROUND

public static final int PART_BACKGROUND

See Also:

Constant Field Values

PART_MAX_BUTTON

public static final int PART_MAX_BUTTON

See Also:

Constant Field Values

PART_MIN_BUTTON

public static final int PART_MIN_BUTTON

See Also:

Constant Field Values

PART_CHEVRON_BUTTON

public static final int PART_CHEVRON_BUTTON

See Also:

Constant Field Values

PART_CLOSE_BUTTON

public static final int PART_CLOSE_BUTTON

See Also:

Constant Field Values

MINIMUM_SIZE

public static final int MINIMUM_SIZE

See Also:

Constant Field Values

Constructor Detail

CTabFolderRenderer

protected CTabFolderRenderer(CTabFolder parent)

Constructs a new instance of this class given its parent.

Parameters:

parent - CTabFolder

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the parent is disposed

See Also:

Widget.getStyle()

Method Detail

antialias

void antialias(int[] shape,
             Color innerColor,
             Color outerColor,
             GC gc)

computeSize

protected Point computeSize(int part,
                int state,
                GC gc,
                int wHint,
                int hHint)

Returns the preferred size of a part.

The preferred size of a part is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the part need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

The part value indicated what component the preferred size is to be calculated for. Valid values are any of the part constants:

• PART_BODY
• PART_HEADER
• PART_BORDER
• PART_BACKGROUND
• PART_MAX_BUTTON
• PART_MIN_BUTTON
• PART_CHEVRON_BUTTON
• PART_CLOSE_BUTTON
• A positive integer which is the index of an item in the CTabFolder.

The state parameter may be one of the following:

• SWT.NONE
• SWT.SELECTED - whether the part is selected

Parameters:

part - a part constant

state - current state

gc - the gc to use for measuring

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

Returns:

the preferred size of the part

Since:

3.6

computeTrim

protected Rectangle computeTrim(int part,
                    int state,
                    int x,
                    int y,
                    int width,
                    int height)

Given a desired client area for the part (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.

In other words, it returns a rectangle such that, if the part's bounds were set to that rectangle, the area of the part which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).

Parameters:

part - one of the part constants

state - the state of the part

x - the desired x coordinate of the client area

y - the desired y coordinate of the client area

width - the desired width of the client area

height - the desired height of the client area

Returns:

the required bounds to produce the given client area

Since:

3.6

See Also:

valid part and state values

createAntialiasColors

void createAntialiasColors()

createSelectionHighlightGradientColors

void createSelectionHighlightGradientColors(Color start)

dispose

protected void dispose()

Dispose of any operating system resources associated with the renderer. Called by the CTabFolder parent upon receiving the dispose event or when changing the renderer.

Since:

3.6

disposeAntialiasColors

void disposeAntialiasColors()

disposeSelectionHighlightGradientColors

void disposeSelectionHighlightGradientColors()

draw

protected void draw(int part,
        int state,
        Rectangle bounds,
        GC gc)

Draw a specified part of the CTabFolder using the provided bounds and GC.

The valid CTabFolder part constants are:

• PART_BODY - the entire body of the CTabFolder
• PART_HEADER - the upper tab area of the CTabFolder
• PART_BORDER - the border of the CTabFolder
• PART_BACKGROUND - the background of the CTabFolder
• PART_MAX_BUTTON
• PART_MIN_BUTTON
• PART_CHEVRON_BUTTON
• PART_CLOSE_BUTTON
• A positive integer which is the index of an item in the CTabFolder.

The state parameter may be a combination of:

• SWT.BACKGROUND - whether the background should be drawn
• SWT.FOREGROUND - whether the foreground should be drawn
• SWT.SELECTED - whether the part is selected
• SWT.HOT - whether the part is hot (i.e. mouse is over the part)

Parameters:

part - part to draw

state - state of the part

bounds - the bounds of the part

gc - the gc to draw the part on

Since:

3.6

drawBackground

void drawBackground(GC gc,
                  Rectangle bounds,
                  int state)

drawBackground

void drawBackground(GC gc,
                  int[] shape,
                  boolean selected)

drawBackground

void drawBackground(GC gc,
                  int[] shape,
                  int x,
                  int y,
                  int width,
                  int height,
                  Color defaultBackground,
                  Image image,
                  Color[] colors,
                  int[] percents,
                  boolean vertical)

drawBorder

void drawBorder(GC gc,
              int[] shape)

drawBody

void drawBody(GC gc,
            Rectangle bounds,
            int state)

drawClose

void drawClose(GC gc,
             Rectangle closeRect,
             int closeImageState)

drawChevron

void drawChevron(GC gc,
               Rectangle chevronRect,
               int chevronImageState)

drawHighlight

void drawHighlight(GC gc,
                 Rectangle bounds,
                 int state,
                 int rightEdge)

drawLeftUnselectedBorder

void drawLeftUnselectedBorder(GC gc,
                            Rectangle bounds,
                            int state)

drawMaximize

void drawMaximize(GC gc,
                Rectangle maxRect,
                int maxImageState)

drawMinimize

void drawMinimize(GC gc,
                Rectangle minRect,
                int minImageState)

drawRightUnselectedBorder

void drawRightUnselectedBorder(GC gc,
                             Rectangle bounds,
                             int state)

drawSelected

void drawSelected(int itemIndex,
                GC gc,
                Rectangle bounds,
                int state)

drawTabArea

void drawTabArea(GC gc,
               Rectangle bounds,
               int state)

drawUnselected

void drawUnselected(int index,
                  GC gc,
                  Rectangle bounds,
                  int state)

fillRegion

void fillRegion(GC gc,
              Region region)

getFillColor

Color getFillColor()

isSelectionHighlightColorsCacheHit

boolean isSelectionHighlightColorsCacheHit(Color start)

setSelectionHighlightGradientColor

void setSelectionHighlightGradientColor(Color start)

shortenText

java.lang.String shortenText(GC gc,
                           java.lang.String text,
                           int width)

shortenText

java.lang.String shortenText(GC gc,
                           java.lang.String text,
                           int width,
                           java.lang.String ellipses)

updateCurves

void updateCurves()

useEllipses

boolean useEllipses()