com.yworks.yfiles.graph.styles

Class IconLabelStyle

java.lang.Object

com.yworks.yfiles.graph.styles.IconLabelStyle

All Implemented Interfaces:

ILabelStyle, ICloneable, Cloneable

public class IconLabelStyle
extends Object
implements ILabelStyle, Cloneable

A label style that draws an icon in addition to the text.

This style draws the icon at the location specified by IconPlacement and delegates the drawing of the label's text to the Wrapped style.

Constructor Summary

Constructors

Constructor and Description
IconLabelStyle() Creates a new instance using no icon and IconLabelStyleRenderer as renderer.
IconLabelStyle(String iconUrl) Creates a new instance using the provided url and IconLabelStyleRenderer as renderer.
IconLabelStyle(String iconUrl, IconLabelStyleRenderer renderer) Creates a new instance using the provided url and renderer.

Method Summary

Modifier and Type	Method and Description
IconLabelStyle	clone() Creates a copy of this object and returns it.
Image	getIcon() Gets the icon to paint for the label.
ILabelModelParameter	getIconPlacement() Gets the parameter that specifies the icon placement.
SizeD	getIconSize() Gets the size of the icon to paint for the label.
IconLabelStyleRenderer	getRenderer() Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given label and this style instance.
String	getUrl() Returns the string representing the URL to get the pixel data of the icon.
ILabelStyle	getWrapped() Gets the style that renders the text of the label.
InsetsD	getWrappedInsets() Gets the insets that should be applied for the layout of the wrapped style rendering.
boolean	isAutoFlippingEnabled() Gets a value indicating whether to automatically flip the rendering should the layout's up vector point downwards.
void	setAutoFlippingEnabled(boolean value) Sets a value indicating whether to automatically flip the rendering should the layout's up vector point downwards.
void	setIconPlacement(ILabelModelParameter value) Sets the parameter that specifies the icon placement.
void	setIconSize(SizeD value) Sets the size of the icon to paint for the label.
void	setUrl(String url) Sets the string representing the URL to get the pixel data of the icon.
void	setWrapped(ILabelStyle value) Sets the style that renders the text of the label.
void	setWrappedInsets(InsetsD value) Sets the insets that should be applied for the layout of the wrapped style rendering.

Methods inherited from class java.lang.Object

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

Constructor Detail

IconLabelStyle

public IconLabelStyle()

Creates a new instance using no icon and IconLabelStyleRenderer as renderer.

IconLabelStyle

public IconLabelStyle(String iconUrl)

Creates a new instance using the provided url and IconLabelStyleRenderer as renderer.

Parameters:

iconUrl - The url of the icon to draw.

IconLabelStyle

public IconLabelStyle(String iconUrl,
                      IconLabelStyleRenderer renderer)

Creates a new instance using the provided url and renderer.

Parameters:

iconUrl - The url of the icon to draw.

renderer - The custom renderer for this style instance.

Method Detail

clone

public final IconLabelStyle clone()

Description copied from interface: ICloneable

Creates a copy of this object and returns it.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A copy of this object.

See Also:

Object.clone()

getIcon

public final Image getIcon()

Gets the icon to paint for the label.

Returns:

The icon.

getIconPlacement

public final ILabelModelParameter getIconPlacement()

Gets the parameter that specifies the icon placement.

All valid node label model parameters can be used. The label's layout will be interpreted as the a node's layout and the icon will be placed relative to that layout as if it was a node's label.

The default value is ExteriorLabelModel.WEST.

Throws:

NullPointerException - value is null.

Returns:

The icon placement parameter.

See Also:

setIconPlacement(ILabelModelParameter)

getIconSize

public final SizeD getIconSize()

Gets the size of the icon to paint for the label.

The default value is SizeD.EMPTY.

Returns:

The icon size.

See Also:

setIconSize(SizeD)

getRenderer

public final IconLabelStyleRenderer getRenderer()

Description copied from interface: ILabelStyle

Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given label and this style instance.

The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:

Specified by:

getRenderer in interface ILabelStyle

Returns:

The Renderer.

getUrl

public String getUrl()

Returns the string representing the URL to get the pixel data of the icon.

getWrapped

public final ILabelStyle getWrapped()

Gets the style that renders the text of the label.

This style will be rendered before the icon and is responsible for rendering the Text, since IconLabelStyleRenderer will only render the Icon.

The default value is DefaultLabelStyle.

Throws:

NullPointerException - value is null.

Returns:

The style that renders the text of the label.

See Also:

setWrapped(ILabelStyle)

getWrappedInsets

public final InsetsD getWrappedInsets()

Gets the insets that should be applied for the layout of the wrapped style rendering.

The IconLabelStyleRenderer.getPreferredSize(com.yworks.yfiles.graph.ILabel, ILabelStyle) will take the preferred size of the Wrapped's ILabelStyleRenderer and add these insets to it. During the rendering these insets will be used to offset the rendering of the wrapped style.

The default insets are empty.

Returns:

The insets for the wrapped style rendering.

See Also:

setWrappedInsets(InsetsD)

isAutoFlippingEnabled

public final boolean isAutoFlippingEnabled()

Gets a value indicating whether to automatically flip the rendering should the layout's up vector point downwards.

The default value is true.

Returns:

true if this style should automatically flip the rendering so that it is never rendered upside down; false otherwise.

See Also:

setAutoFlippingEnabled(boolean)

setAutoFlippingEnabled

public final void setAutoFlippingEnabled(boolean value)

Sets a value indicating whether to automatically flip the rendering should the layout's up vector point downwards.

The default value is true.

Parameters:

value - true if this style should automatically flip the rendering so that it is never rendered upside down; false otherwise.

See Also:

isAutoFlippingEnabled()

setIconPlacement

public final void setIconPlacement(ILabelModelParameter value)

Sets the parameter that specifies the icon placement.

All valid node label model parameters can be used. The label's layout will be interpreted as the a node's layout and the icon will be placed relative to that layout as if it was a node's label.

The default value is ExteriorLabelModel.WEST.

Throws:

NullPointerException - value is null.

Parameters:

value - The icon placement parameter.

See Also:

getIconPlacement()

setIconSize

public final void setIconSize(SizeD value)

Sets the size of the icon to paint for the label.

The default value is SizeD.EMPTY.

Parameters:

value - The icon size.

See Also:

getIconSize()

setUrl

public void setUrl(String url)

Sets the string representing the URL to get the pixel data of the icon.

setWrapped

public final void setWrapped(ILabelStyle value)

Sets the style that renders the text of the label.

This style will be rendered before the icon and is responsible for rendering the Text, since IconLabelStyleRenderer will only render the Icon.

The default value is DefaultLabelStyle.

Throws:

NullPointerException - value is null.

Parameters:

value - The style that renders the text of the label.

See Also:

getWrapped()

setWrappedInsets

public final void setWrappedInsets(InsetsD value)

Sets the insets that should be applied for the layout of the wrapped style rendering.

The IconLabelStyleRenderer.getPreferredSize(com.yworks.yfiles.graph.ILabel, ILabelStyle) will take the preferred size of the Wrapped's ILabelStyleRenderer and add these insets to it. During the rendering these insets will be used to offset the rendering of the wrapped style.

The default insets are empty.

Parameters:

value - The insets for the wrapped style rendering.

See Also:

getWrappedInsets()