com.yworks.yfiles.graph.styles

Class ImageNodeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.ImageNodeStyle

All Implemented Interfaces:

INodeStyle, ICloneable, Cloneable

public class ImageNodeStyle
extends Object
implements INodeStyle, Cloneable

A node style that can use an image for the visual representation of a node.

This style can be used together with ImageNodeStyleRenderer instances.

Constructor Summary

Constructors

Constructor and Description
ImageNodeStyle() Creates a new instance with no image and ImageNodeStyleRenderer as renderer.
ImageNodeStyle(URL imageUrl) Creates a new instance that uses the specified image and ImageNodeStyleRenderer as renderer.
ImageNodeStyle(URL imageUrl, INodeStyleRenderer styleRenderer) Create a new instance of this style with a custom renderer instance

Method Summary

Modifier and Type	Method and Description
ImageNodeStyle	clone() Creates a copy of this object and returns it.
Image	getImage() Gets the image that is used for the style instance.
GeneralPath	getNormalizedOutline() Gets the Shape of the 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.
URL	getUrl() Returns the string representing the URL to get the pixel data of the image.
void	setNormalizedOutline(GeneralPath value) Sets the normalized outline of the image that will be displayed.
void	setUrl(URL url) Sets the string representing the URL to get the pixel data of the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageNodeStyle

public ImageNodeStyle()

Creates a new instance with no image and ImageNodeStyleRenderer as renderer.

ImageNodeStyle

public ImageNodeStyle(URL imageUrl)

Creates a new instance that uses the specified image and ImageNodeStyleRenderer as renderer.

Parameters:

imageSource - The image to use.

ImageNodeStyle

public ImageNodeStyle(URL imageUrl,
                      INodeStyleRenderer styleRenderer)

Create a new instance of this style with a custom renderer instance

Parameters:

imageUrl - The url to read the pixed data from.

styleRenderer - The custom renderer for this instance

Method Detail

clone

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

getImage

public Image getImage()

Gets the image that is used for the style instance.

The default value is null.

Returns:

The Image.

See Also:

#setImage(Image)

getNormalizedOutline

public final GeneralPath getNormalizedOutline()

Gets the Shape of the 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.

Note that this property won't be serialized properly except for its default which is null. To manage serializing the Shape one can use com.yworks.yfiles.graphml.GraphMLIOHandler#addQueryReferenceIdListener(com.yworks.util.EventHandler) and specify a reference id.

Returns:

The NormalizedOutline.

See Also:

setNormalizedOutline(GeneralPath)

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.

getUrl

public URL getUrl()

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

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.

Note that this property won't be serialized properly except for its default which is null. To manage serializing the Shape one can use com.yworks.yfiles.graphml.GraphMLIOHandler#addQueryReferenceIdListener(com.yworks.util.EventHandler) and specify a reference id.

Parameters:

value - The NormalizedOutline to set.

See Also:

getNormalizedOutline()

setUrl

public void setUrl(URL url)

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