com.yworks.yfiles.graph.styles

Class TemplateNodeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.AbstractTemplateStyle<INode>

com.yworks.yfiles.graph.styles.TemplateNodeStyle

All Implemented Interfaces:

INodeStyle, ICloneable, Cloneable

public class TemplateNodeStyle
extends AbstractTemplateStyle<INode>
implements INodeStyle

An INodeStyle implementation that can render complex FXML controls for the visualization of INodes using a TemplateNodeStyleRenderer.

The StyleResourceKey is used to determine the URL of the FXML file that will be applied to the Node. The URL will be looked-up from the Resources of the CanvasControl the style is used in.

Constructor Summary

Constructors

Constructor and Description
TemplateNodeStyle() Creates a new instance with no style resource key and TemplateNodeStyleRenderer as renderer.
TemplateNodeStyle(String styleResourceKey) Creates a new instance using the given resource key and TemplateNodeStyleRenderer as renderer.
TemplateNodeStyle(String styleResourceKey, TemplateNodeStyleRenderer renderer) Creates a new instance using the given resource key and a custom renderer instance.

Method Summary

Modifier and Type	Method and Description
Node	createControl(IRenderContext context, INode node) Factory method that is called by the TemplateNodeStyleRenderer to create the control that will be used for the display of the node.
InsetsD	getInsets() Gets the insets the INodeInsetsProvider implementation for INode should yield for this instance.
SizeD	getMinimumSize() Gets the minimum size an INodeSizeConstraintProvider implementation for INode should yield.
GeneralPath	getNormalizedOutline() Gets the normalized outline of a node that will be displayed using the created control.
SizeD	getPreferredSize(IRenderContext context, INode node) Convenience method that determines the preferred size of the node if this style was applied.
TemplateNodeStyleRenderer	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.
protected URL	getStyle(IRenderContext context, IModelItem node) Callback method that determines the URL to the FXML file which encodes the Control.
String	getStyleResourceKey() Gets the String that will be used to look up the URL to the FXML file which encodes the Control.
void	setInsets(InsetsD value) Sets the insets the INodeInsetsProvider implementation for INode should yield for this instance.
void	setMinimumSize(SizeD value) Sets the minimum size an INodeSizeConstraintProvider implementation for INode should yield.
void	setNormalizedOutline(GeneralPath value) Sets the normalized outline of a node that will be displayed using the created control.
void	setStyleResourceKey(String value) Sets the String that will be used to look up the URL to the FXML file which encodes the Control.

Methods inherited from class com.yworks.yfiles.graph.styles.AbstractTemplateStyle

addPropertyChangedListener, clone, getCanvasPropertyKey, getClassLoader, getContentPropertyKey, getContextLookup, getFXMLLoader, getItemPropertyKey, getStyleTag, onPropertyChanged, removePropertyChangedListener, setCanvasPropertyKey, setClassLoader, setContentPropertyKey, setContextLookup, setItemPropertyKey, setStyleTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.utils.ICloneable

clone

Constructor Detail

TemplateNodeStyle

public TemplateNodeStyle()

Creates a new instance with no style resource key and TemplateNodeStyleRenderer as renderer.

TemplateNodeStyle

public TemplateNodeStyle(String styleResourceKey)

Creates a new instance using the given resource key and TemplateNodeStyleRenderer as renderer.

Parameters:

styleResourceKey - The key of the style resource that will be used for the Node.

TemplateNodeStyle

public TemplateNodeStyle(String styleResourceKey,
                         TemplateNodeStyleRenderer renderer)

Creates a new instance using the given resource key and a custom renderer instance.

Parameters:

styleResourceKey - The key of the style resource that will be used for the Node.

renderer - The custom renderer for this instance.

Method Detail

createControl

public Node createControl(IRenderContext context,
                          INode node)

Factory method that is called by the TemplateNodeStyleRenderer to create the control that will be used for the display of the node.

Parameters:

context - The context for which the control should be created.

node - The node that will be rendered.

Returns:

The readily styled control.

getInsets

public final InsetsD getInsets()

Gets the insets the INodeInsetsProvider implementation for INode should yield for this instance.

This is especially useful if this style is used for group nodes, as they require insets for the calculation of the bounds. The insets can be used to make sure that child nodes do not cover visual elements of the style inside the insets. The default value is an InsetsD insets with 5 for all insets.

Returns:

The Insets.

See Also:

INodeInsetsProvider, INodeStyleRenderer.getContext(INode, INodeStyle), setInsets(InsetsD)

getMinimumSize

public final SizeD getMinimumSize()

Gets the minimum size an INodeSizeConstraintProvider implementation for INode should yield.

The default value is SizeD.EMPTY.

Returns:

The MinimumSize.

See Also:

INodeSizeConstraintProvider, setMinimumSize(SizeD)

getNormalizedOutline

public final GeneralPath getNormalizedOutline()

Gets the normalized outline of a node that will be displayed using the created control.

This shape will be used to satisfy requests to IMarqueeTestable.isInBox(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.RectD), IHitTestable.isHit(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD), as well as for IShapeGeometry methods (which affect edge cropping at the node outline).

This property may be left at or set to null to indicate default (rectangular) behavior.

The default value is null.

Returns:

The NormalizedOutline.

See Also:

setNormalizedOutline(GeneralPath)

getPreferredSize

public SizeD getPreferredSize(IRenderContext context,
                              INode node)

Convenience method that determines the preferred size of the node if this style was applied.

Parameters:

context - The context for which the size should be calculated. Can be obtained through CanvasControl.createRenderContext().

node - The node to determine the preferred size of. Can be a live node or an SimpleNode.

Returns:

The preferred size.

See Also:

CanvasControl.createRenderContext()

getRenderer

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

getStyle

protected URL getStyle(IRenderContext context,
                       IModelItem node)

Callback method that determines the URL to the FXML file which encodes the Control.

Parameters:

context - The context for which the style is needed.

node - The node that will be rendered.

Returns:

The style instance or null.

getStyleResourceKey

public final String getStyleResourceKey()

Gets the String that will be used to look up the URL to the FXML file which encodes the Control.

The default value is null.

Returns:

The resource key for the style or null in which case the default template will be used.

See Also:

setStyleResourceKey(java.lang.String)

setInsets

public final void setInsets(InsetsD value)

Sets the insets the INodeInsetsProvider implementation for INode should yield for this instance.

This is especially useful if this style is used for group nodes, as they require insets for the calculation of the bounds. The insets can be used to make sure that child nodes do not cover visual elements of the style inside the insets. The default value is an InsetsD insets with 5 for all insets.

Parameters:

value - The Insets to set.

See Also:

INodeInsetsProvider, INodeStyleRenderer.getContext(INode, INodeStyle), getInsets()

setMinimumSize

public final void setMinimumSize(SizeD value)

Sets the minimum size an INodeSizeConstraintProvider implementation for INode should yield.

The default value is SizeD.EMPTY.

Parameters:

value - The MinimumSize to set.

See Also:

INodeSizeConstraintProvider, getMinimumSize()

setNormalizedOutline

public final void setNormalizedOutline(GeneralPath value)

Sets the normalized outline of a node that will be displayed using the created control.

This shape will be used to satisfy requests to IMarqueeTestable.isInBox(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.RectD), IHitTestable.isHit(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD), as well as for IShapeGeometry methods (which affect edge cropping at the node outline).

This property may be left at or set to null to indicate default (rectangular) behavior.

The default value is null.

Parameters:

value - The NormalizedOutline to set.

See Also:

getNormalizedOutline()

setStyleResourceKey

public final void setStyleResourceKey(String value)

Sets the String that will be used to look up the URL to the FXML file which encodes the Control.

The default value is null.

Parameters:

value - The resource key for the style or null in which case the default template will be used.

See Also:

getStyleResourceKey()