com.yworks.yfiles.view

Class LabelStyleDecorationInstaller

java.lang.Object

com.yworks.yfiles.view.LabelStyleDecorationInstaller

All Implemented Interfaces:

ICanvasObjectInstaller, IFocusIndicatorInstaller, IHighlightIndicatorInstaller, ISelectionIndicatorInstaller

public class LabelStyleDecorationInstaller
extends Object
implements ISelectionIndicatorInstaller, IHighlightIndicatorInstaller, IFocusIndicatorInstaller

Allows the use of an ILabelStyle to render the selection, highlight or focus indicator of labels.

The ZoomPolicy property defines how the zoom level affects the rendering of the indicator. It can either scale according to the zoom level similar to regular graph items or have always to same thickness regardless of the zoom, similar to the default yFiles indicators.

See Also:

EdgeStyleDecorationInstaller, NodeStyleDecorationInstaller

Constructor Summary

Constructors

Constructor and Description
LabelStyleDecorationInstaller() Create a new instance of this class.

Method Summary

Modifier and Type	Method and Description
ICanvasObject	addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) Installs a rendering for the item if it is an ILabel.
ILabelStyle	getLabelStyle() The style to use for the rendering.
InsetsD	getMargin() Specifies the margin around the label layout.
StyleDecorationZoomPolicy	getZoomPolicy() Specifies how the style is affected by the current zoom level.
void	setLabelStyle(ILabelStyle value) The style to use for the rendering.
void	setMargin(InsetsD value) Specifies the margin around the label layout.
void	setZoomPolicy(StyleDecorationZoomPolicy value) Specifies how the style is affected by the current zoom level.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelStyleDecorationInstaller

public LabelStyleDecorationInstaller()

Create a new instance of this class.

Method Detail

addCanvasObject

public final ICanvasObject addCanvasObject(ICanvasContext context,
                                           ICanvasObjectGroup group,
                                           Object item)

Installs a rendering for the item if it is an ILabel.

Specified by:

addCanvasObject in interface ICanvasObjectInstaller

Parameters:

context - The canvas context.

group - The canvas object group to add the newly created canvas object to.

item - The item to install.

Returns:

The canvas object representing the item.

getLabelStyle

public final ILabelStyle getLabelStyle()

The style to use for the rendering.

Changes of the value of this property are not propagated to already created styles.

Returns:

The LabelStyle.

See Also:

setLabelStyle(ILabelStyle)

getMargin

public final InsetsD getMargin()

Specifies the margin around the label layout.

Actually, the bounds rendered by the style is the original label layout enlarged by this margin.

Changes of the value of this property are propagated to all styles created by this instance and become immediately visible.

Returns:

The Margin.

See Also:

setMargin(InsetsD)

getZoomPolicy

public final StyleDecorationZoomPolicy getZoomPolicy()

Specifies how the style is affected by the current zoom level.

Changes of the value of this property are propagated to all styles created by this instance and become immediately visible.

Returns:

The ZoomPolicy.

See Also:

setZoomPolicy(StyleDecorationZoomPolicy)

setLabelStyle

public final void setLabelStyle(ILabelStyle value)

The style to use for the rendering.

Changes of the value of this property are not propagated to already created styles.

Parameters:

value - The LabelStyle to set.

See Also:

getLabelStyle()

setMargin

public final void setMargin(InsetsD value)

Specifies the margin around the label layout.

Actually, the bounds rendered by the style is the original label layout enlarged by this margin.

Changes of the value of this property are propagated to all styles created by this instance and become immediately visible.

Parameters:

value - The Margin to set.

See Also:

getMargin()

setZoomPolicy

public final void setZoomPolicy(StyleDecorationZoomPolicy value)

Specifies how the style is affected by the current zoom level.

Changes of the value of this property are propagated to all styles created by this instance and become immediately visible.

Parameters:

value - The ZoomPolicy to set.

See Also:

getZoomPolicy()