com.yworks.yfiles.graph.styles

Class MemoryImageNodeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.MemoryImageNodeStyle

All Implemented Interfaces:

INodeStyle, ICloneable, Cloneable

public class MemoryImageNodeStyle
extends Object
implements INodeStyle, Cloneable

An implementation of the INodeStyle interface that uses BitmapSource that are built from memory as visual representation of a node.

During serialization this instance will serialize the contents of the image.

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 serialization and deserialization handler.

See Also:

com.yworks.yfiles.drawing.ImageNodeStyle

Constructor Summary

Constructors

Constructor and Description
MemoryImageNodeStyle() Creates a new instance.
MemoryImageNodeStyle(Image imageSource) Creates a new instance with the given imageSource.
MemoryImageNodeStyle(Image imageSource, INodeStyleRenderer renderer) Creates a new instance using the specified image and a custom renderer instance.

Method Summary

Modifier and Type	Method and Description
MemoryImageNodeStyle	clone() This implementation performs a shallow copy with respect to the BitmapSource property.
Image	getBitmapSource() Gets the bitmap source.
GeneralPath	getNormalizedOutline() Gets the normalized outline of the image that will be displayed.
INodeStyleRenderer	getRenderer() Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given node and this style instance.
void	setBitmapSource(Image value) Sets the bitmap source.
void	setNormalizedOutline(GeneralPath value) Sets the normalized outline of the image that will be displayed.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryImageNodeStyle

public MemoryImageNodeStyle()

Creates a new instance.

MemoryImageNodeStyle

public MemoryImageNodeStyle(Image imageSource)

Creates a new instance with the given imageSource.

Parameters:

imageSource - The image to use.

MemoryImageNodeStyle

public MemoryImageNodeStyle(Image imageSource,
                            INodeStyleRenderer renderer)

Creates a new instance using the specified image and a custom renderer instance.

Parameters:

image - The image to use.

renderer - The custom renderer for this instance.

Method Detail

clone

public MemoryImageNodeStyle clone()

This implementation performs a shallow copy with respect to the BitmapSource property.

If clients need to have a deep copy of this instance, they need to manually clone and reassign the BitmapSource to the clone.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A shallow copy of this instance.

See Also:

Object.clone()

getBitmapSource

public Image getBitmapSource()

Gets the bitmap source.

The default value is null.

Returns:

The bitmap source.

See Also:

setBitmapSource(Image)

getNormalizedOutline

public final GeneralPath getNormalizedOutline()

Gets the normalized outline of the image that will be displayed.

This shape will be used to satisfy requests to IMarqueeTestable.isInBox(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.RectD) and IHitTestable.isHit(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD) and may be left null to indicate default (rectangular) behavior.

Returns:

The OutlineShape.

See Also:

#setOutlineShape(Shape)

getRenderer

public final INodeStyleRenderer getRenderer()

Description copied from interface: INodeStyle

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

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

Specified by:

getRenderer in interface INodeStyle

Returns:

The Renderer.

setBitmapSource

public void setBitmapSource(Image value)

Sets the bitmap source.

The default value is null.

Parameters:

value - The bitmap source.

See Also:

getBitmapSource()

setNormalizedOutline

public final void setNormalizedOutline(GeneralPath value)

Sets the normalized outline of the image that will be displayed.

This shape will be used to satisfy requests to IMarqueeTestable.isInBox(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.RectD) and IHitTestable.isHit(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD) and may be left null to indicate default (rectangular) behavior.

Parameters:

value - The OutlineShape to set.

See Also:

#getOutlineShape()