com.yworks.yfiles.graph.styles

Class MemoryIconLabelStyle

java.lang.Object

com.yworks.yfiles.graph.styles.MemoryIconLabelStyle

All Implemented Interfaces:

ILabelStyle, ICloneable, Cloneable

public class MemoryIconLabelStyle
extends Object
implements ILabelStyle, Cloneable

A mutable implementation of the ILabelStyle interface that uses BitmapSources that are built from memory as the icon. During serialization this instance will serialize the contents of the icon.

Note: by default the image contents are serialized in PNG format. Since the PNG conversion depends on classes in packages javax.imageio and javafx.embed.swing image serialization will not be handled on platforms where these packages are not available (e.g. Android). Developers who want to provide serialization support for images on these platforms have to register a custom GraphMLIOHandler.addHandleSerializationListener(IEventHandler) serialization} and GraphMLIOHandler.addHandleDeserializationListener(IEventHandler) deserialization} handler.

Constructor Summary

Constructors

Constructor and Description
MemoryIconLabelStyle() Creates a new instance using no icon and IconLabelStyleRenderer as renderer.
MemoryIconLabelStyle(Image icon) Creates a new instance using the provided icon and IconLabelStyleRenderer as renderer.
MemoryIconLabelStyle(Image icon, IconLabelStyleRenderer renderer) Creates a new instance using the provided icon and renderer.

Method Summary

Modifier and Type	Method and Description
MemoryIconLabelStyle	clone() Creates a copy of this object and returns it.
Image	getIcon() Gets the icon to paint for the label.
ILabelModelParameter	getIconPlacement() Gets the icon placement model parameter.
SizeD	getIconSize() Gets the size of the icon to paint for the label.
ILabelStyle	getInnerStyle() Gets the inner style to decorate.
InsetsD	getInnerStyleInsets() Gets the insets that should be applied for the layout of the inner style rendering.
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.
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	setIcon(Image value) Sets the icon to paint for the label.
void	setIconPlacement(ILabelModelParameter value) Sets the icon placement model parameter.
void	setIconSize(SizeD value) Sets the size of the icon to paint for the label.
void	setInnerStyle(ILabelStyle value) Sets the inner style to decorate.
void	setInnerStyleInsets(InsetsD value) Sets the insets that should be applied for the layout of the inner style rendering.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryIconLabelStyle

public MemoryIconLabelStyle()

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

MemoryIconLabelStyle

public MemoryIconLabelStyle(Image icon)

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

Parameters:

icon - The icon to draw.

MemoryIconLabelStyle

public MemoryIconLabelStyle(Image icon,
                            IconLabelStyleRenderer renderer)

Creates a new instance using the provided icon and renderer.

Parameters:

icon - The icon to draw.

renderer - The custom renderer for this style instance.

Method Detail

clone

public final MemoryIconLabelStyle 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.

See Also:

setIcon(Image)

getIconPlacement

public final ILabelModelParameter getIconPlacement()

Gets the icon placement model parameter.

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)

getInnerStyle

public final ILabelStyle getInnerStyle()

Gets the inner style to decorate.

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 inner style to decorate.

See Also:

setInnerStyle(ILabelStyle)

getInnerStyleInsets

public final InsetsD getInnerStyleInsets()

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

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

The default insets are empty.

Returns:

The insets for the inner style rendering.

See Also:

setInnerStyleInsets(InsetsD)

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.

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; otherwise, false.

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; otherwise, false.

See Also:

isAutoFlippingEnabled()

setIcon

public final void setIcon(Image value)

Sets the icon to paint for the label.

Parameters:

value - The icon.

See Also:

getIcon()

setIconPlacement

public final void setIconPlacement(ILabelModelParameter value)

Sets the icon placement model parameter.

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()

setInnerStyle

public final void setInnerStyle(ILabelStyle value)

Sets the inner style to decorate.

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 inner style to decorate.

See Also:

getInnerStyle()

setInnerStyleInsets

public final void setInnerStyleInsets(InsetsD value)

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

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

The default insets are empty.

Parameters:

value - The insets for the inner style rendering.

See Also:

getInnerStyleInsets()