Package org.eclipse.graphiti.internal.contextbuttons

Class StandardContextButtonPadDeclaration

java.lang.Object

org.eclipse.graphiti.internal.contextbuttons.AbstractContextButtonPadDeclaration

org.eclipse.graphiti.internal.contextbuttons.StandardContextButtonPadDeclaration

All Implemented Interfaces:

IContextButtonPadDeclaration

public class StandardContextButtonPadDeclaration
extends AbstractContextButtonPadDeclaration

An implementation of IContextButtonPadDeclaration which is based on the UX guidelines.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.graphiti.internal.contextbuttons.IContextButtonPadDeclaration

IContextButtonPadDeclaration.PadStyle

Constructor Summary

Constructors

Constructor	Description
StandardContextButtonPadDeclaration(IContextButtonPadData contextButtonPadData)

Method Summary

Modifier and Type	Method	Description
PositionedContextButton	createButton(IContextButtonEntry entry, Rectangle position)	Creates a PositionedContextButton for a given context button entry and position.
protected int	getButtonPadding()	Returns the padding between the generic and domain-specific context buttons.
protected int	getButtonSize()	Returns the size of the generic and domain-specific context buttons.
protected int	getCollapseButtonPadding()	Returns the padding between the collapse context button and the other generic context buttons.
int	getPadAppendageLength()	Returns the length of the pad appendage, which is shown if the neighboring pad does not exist.
int	getPadCornerRadius()	Returns the corner radius which is used to paint all corners of the pad.
double	getPadDefaultOpacity()	Returns the opacity which is used when painting the pad.
IColorConstant	getPadFillColor()	Returns the color in which the pads outline is filled.
protected int	getPadHorizontalOverlap()	Returns the horizontal overlap of the pads (top with right, right with bottom).
IColorConstant	getPadInnerLineColor()	Returns the color in which the inner line of the pads outline is painted.
int	getPadLineWidth()	Returns the line width which is used to paint the outline of the pad.
IColorConstant	getPadMiddleLineColor()	Returns the color in which the middle line of the pads outline is painted.
IColorConstant	getPadOuterLineColor()	Returns the color in which the outer line of the pads outline is painted.
protected int	getPadPaddingInside()	Returns the padding of the generic and domain-specific context buttons at the inside of the context button pad.
protected int	getPadPaddingOutside()	Returns the padding of the generic and domain-specific context buttons at the outside of the context button pad.
protected int	getPadVerticalOverlap()	Returns the vertical overlap of the pads (top with right, right with bottom).

Methods inherited from class org.eclipse.graphiti.internal.contextbuttons.AbstractContextButtonPadDeclaration

getBottomPad, getCollapseAndGenericButtons, getCollapseButton, getContainmentRectangles, getDomainButtons, getDomainButtonsBottom, getDomainButtonsRight, getGenericButtons, getOriginalReferenceRectangle, getOverlappingContainmentRectangles, getPadReferenceRectangle, getPositionedContextButtons, getRightPad, getRightPadStyle, getTopPad, getTopPadStyle, initializeButtonPositions, initializeContainmentRectangles, initializeDomainButtonLists, initializeRectangles

Methods inherited from class java.lang.Object

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

Constructor Details

StandardContextButtonPadDeclaration

public StandardContextButtonPadDeclaration(IContextButtonPadData contextButtonPadData)

Method Details

getButtonSize

protected int getButtonSize()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the size of the generic and domain-specific context buttons.

Specified by:

getButtonSize in class AbstractContextButtonPadDeclaration

Returns:

The size of the generic and domain-specific context buttons.

getButtonPadding

protected int getButtonPadding()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the padding between the generic and domain-specific context buttons.

Specified by:

getButtonPadding in class AbstractContextButtonPadDeclaration

Returns:

The padding between the generic and domain-specific context buttons.

getCollapseButtonPadding

protected int getCollapseButtonPadding()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the padding between the collapse context button and the other generic context buttons.

Specified by:

getCollapseButtonPadding in class AbstractContextButtonPadDeclaration

Returns:

The padding between the collapse context button and the other generic context buttons.

getPadPaddingOutside

protected int getPadPaddingOutside()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the padding of the generic and domain-specific context buttons at the outside of the context button pad.

Specified by:

getPadPaddingOutside in class AbstractContextButtonPadDeclaration

Returns:

The padding of the generic and domain-specific context buttons at the outside of the context button pad.

getPadPaddingInside

protected int getPadPaddingInside()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the padding of the generic and domain-specific context buttons at the inside of the context button pad.

Specified by:

getPadPaddingInside in class AbstractContextButtonPadDeclaration

Returns:

The padding of the generic and domain-specific context buttons at the inside of the context button pad.

getPadHorizontalOverlap

protected int getPadHorizontalOverlap()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the horizontal overlap of the pads (top with right, right with bottom).

Specified by:

getPadHorizontalOverlap in class AbstractContextButtonPadDeclaration

Returns:

The horizontal overlap of the pads (top with right, right with bottom).

getPadVerticalOverlap

protected int getPadVerticalOverlap()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the vertical overlap of the pads (top with right, right with bottom).

Specified by:

getPadVerticalOverlap in class AbstractContextButtonPadDeclaration

Returns:

The vertical overlap of the pads (top with right, right with bottom).

getPadAppendageLength

public int getPadAppendageLength()

Description copied from class: AbstractContextButtonPadDeclaration

Returns the length of the pad appendage, which is shown if the neighboring pad does not exist.

Specified by:

getPadAppendageLength in class AbstractContextButtonPadDeclaration

Returns:

The length of the pad appendage, which is shown if the neighboring pad does not exist.

getPadLineWidth

public int getPadLineWidth()

Description copied from interface: IContextButtonPadDeclaration

Returns the line width which is used to paint the outline of the pad.

Returns:

The line width which is used to paint the outline of the pad.

getPadCornerRadius

public int getPadCornerRadius()

Description copied from interface: IContextButtonPadDeclaration

Returns the corner radius which is used to paint all corners of the pad.

Returns:

The corner radius which is used to paint all corners of the pad.

getPadOuterLineColor

public IColorConstant getPadOuterLineColor()

Description copied from interface: IContextButtonPadDeclaration

Returns the color in which the outer line of the pads outline is painted. Note, that the pad is outlined with three adjacent lines (outer, middle, inner) and then filled inside.

Returns:

The color in which the outer line of the pads outline is painted.

getPadMiddleLineColor

public IColorConstant getPadMiddleLineColor()

Description copied from interface: IContextButtonPadDeclaration

Returns the color in which the middle line of the pads outline is painted. Note, that the pad is outlined with three adjacent lines (outer, middle, inner) and then filled inside.

Returns:

The color in which the middle line of the pads outline is painted.

getPadInnerLineColor

public IColorConstant getPadInnerLineColor()

Description copied from interface: IContextButtonPadDeclaration

Returns the color in which the inner line of the pads outline is painted. Note, that the pad is outlined with three adjacent lines (outer, middle, inner) and then filled inside.

Returns:

The color in which the inner line of the pads outline is painted.

getPadFillColor

public IColorConstant getPadFillColor()

Description copied from interface: IContextButtonPadDeclaration

Returns the color in which the pads outline is filled. Note, that the pad is outlined with three adjacent lines (outer, middle, inner) and then filled inside.

Returns:

The color in which the pads outline is filled.

getPadDefaultOpacity

public double getPadDefaultOpacity()

Description copied from interface: IContextButtonPadDeclaration

Returns the opacity which is used when painting the pad. Possible values are between 0.0 (invisible, transparent) and 1.0 (completely visible, opaque).

Returns:

The opacity which is used when painting the pad.

createButton

public PositionedContextButton createButton(IContextButtonEntry entry,
 Rectangle position)

Description copied from class: AbstractContextButtonPadDeclaration

Creates a PositionedContextButton for a given context button entry and position. This method can be implemented to set all the visual attributes of the context buttons (line-width, color, opacity, ...).

Specified by:

createButton in class AbstractContextButtonPadDeclaration