org.eclipse.ui.forms.widgets

Class ToggleHyperlink [ source ]

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.swt.widgets.Canvas

org.eclipse.ui.forms.widgets.AbstractHyperlink

org.eclipse.ui.forms.widgets.ToggleHyperlink

All Implemented Interfaces:

Drawable

Direct Known Subclasses:

Chevron, TreeNode, Twistie

public abstract class ToggleHyperlink
extends AbstractHyperlink

A custom selectable control that can be used to control areas that can be expanded or collapsed.

This is an abstract class. Subclasses are responsible for rendering the control using decoration and hover decoration color. Control should be rendered based on the current expansion state.

Styles:

None

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hover
protected int	innerHeight
protected int	innerWidth

Fields inherited from class org.eclipse.ui.forms.widgets.AbstractHyperlink

marginHeight, marginWidth, paintFocus

Fields inherited from class org.eclipse.swt.widgets.Widget

handle

Constructor Summary

Constructors

Constructor and Description
ToggleHyperlink(Composite parent, int style) Creates a control in a provided composite.

Method Summary

Methods

Modifier and Type	Method and Description
Point	computeSize(int wHint, int hHint, boolean changed) Computes the size of the control.
Color	geHoverDecorationColor() Deprecated. use getHoverDecorationColor
Color	getDecorationColor() Returns the color of the decoration.
Color	getHoverDecorationColor() Returns the hover color of the decoration.
boolean	isExpanded() Returns the expansion state of the toggle control.
void	setDecorationColor(Color decorationColor) Sets the color of the decoration.
void	setExpanded(boolean expanded) Sets the expansion state of the twistie control
void	setHoverDecorationColor(Color hoverColor) Sets the hover color of decoration.
(package private) void	triggerAccessible()

Methods inherited from class org.eclipse.ui.forms.widgets.AbstractHyperlink

addHyperlinkListener, getHref, getSelection, getText, handleActivate, handleEnter, handleExit, paint, paintHyperlink, removeHyperlinkListener, setEnabled, setHref

Methods inherited from class org.eclipse.swt.widgets.Canvas

drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setAlpha, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getAlpha, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getTransform, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEffect, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setTransform, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

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

Field Detail

innerWidth

protected int innerWidth

innerHeight

protected int innerHeight

hover

protected boolean hover

Constructor Detail

ToggleHyperlink

public ToggleHyperlink(Composite parent,
               int style)

Creates a control in a provided composite.

Parameters:

parent - the parent

style - the style

Method Detail

setDecorationColor

public void setDecorationColor(Color decorationColor)

Sets the color of the decoration.

Parameters:

decorationColor -

getDecorationColor

public Color getDecorationColor()

Returns the color of the decoration.

Returns:

decoration color

setHoverDecorationColor

public void setHoverDecorationColor(Color hoverColor)

Sets the hover color of decoration. Hover color will be used when mouse enters the decoration area.

Parameters:

hoverColor - the hover color to use

getHoverDecorationColor

public Color getHoverDecorationColor()

Returns the hover color of the decoration.

Returns:

the hover color of the decoration.

Since:

3.1

geHoverDecorationColor

public Color geHoverDecorationColor()

Deprecated. use getHoverDecorationColor

Returns the hover color of the decoration.

Returns:

the hover color of the decoration.

See Also:

getHoverDecorationColor()

computeSize

public Point computeSize(int wHint,
                int hHint,
                boolean changed)

Computes the size of the control.

Overrides:

computeSize in class Composite

Parameters:

wHint - width hint

hHint - height hint

changed - if true, flush any saved layout state

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(boolean), "computeTrim, getClientArea for controls that implement them"

isExpanded

public boolean isExpanded()

Returns the expansion state of the toggle control. When toggle is in the normal (downward) state, the value is true . Collapsed control will return false .

Returns:

false if collapsed, true otherwise.

setExpanded

public void setExpanded(boolean expanded)

Sets the expansion state of the twistie control

Parameters:

expanded - the expansion state

triggerAccessible

void triggerAccessible()

Overrides:

triggerAccessible in class AbstractHyperlink