com.yworks.yfiles.graph.styles

Class TemplatePortStyle

java.lang.Object

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

com.yworks.yfiles.graph.styles.TemplatePortStyle

All Implemented Interfaces:

IPortStyle, ICloneable, Cloneable

public class TemplatePortStyle
extends AbstractTemplateStyle<IPort>
implements IPortStyle

An implementation of the IPortStyle interface that can render complex Nodes for the visualization of IPorts by using TemplatePortStyleRenderer.

The StyleResourceKey is used to determine the Style that will be applied to the Node. The style will be looked-up from the CanvasControl the style is used in. Note that the RenderSize should be specified to match the size of the control style.

Constructor Summary

Constructors

Constructor and Description
TemplatePortStyle() Creates a new instance with no style resource key and TemplatePortStyleRenderer as renderer.
TemplatePortStyle(String styleResourceKey) Creates a new instance using the given resource key and a custom renderer instance TemplatePortStyleRenderer as renderer.
TemplatePortStyle(String styleResourceKey, TemplatePortStyleRenderer 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, IPort port) Factory method that is called by the TemplatePortStyleRenderer to create the control that will be used for the display of the port.
GeneralPath	getNormalizedOutline() Gets the normalized outline of a port that will be displayed using the created control.
SizeD	getPreferredSize(IRenderContext context, IPort port) Convenience method that determines the preferred RenderSize of the port if this style was applied.
TemplatePortStyleRenderer	getRenderer() Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given port and this style instance.
SizeD	getRenderSize() Gets the SizeD of a port that will be displayed using the created control.
protected URL	getStyle(IRenderContext context, IModelItem port) Callback method that determines the Style for the Node.
String	getStyleResourceKey() Gets the String that will be used to look up the URL to the FXML file which encodes the Control.
void	setNormalizedOutline(GeneralPath value) Sets the normalized outline of a port that will be displayed using the created control.
void	setRenderSize(SizeD value) Sets the SizeD of a port 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

TemplatePortStyle

public TemplatePortStyle()

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

TemplatePortStyle

public TemplatePortStyle(String styleResourceKey)

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

Parameters:

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

TemplatePortStyle

public TemplatePortStyle(String styleResourceKey,
                         TemplatePortStyleRenderer 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 style instance.

Method Detail

createControl

public Node createControl(IRenderContext context,
                          IPort port)

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

Parameters:

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

port - The port that will be rendered.

Returns:

The readily styled control.

getNormalizedOutline

public final GeneralPath getNormalizedOutline()

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

The shape will automatically be arranged and transformed to have the bounds of the port. 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.

The default value is null.

Returns:

The NormalizedOutline.

See Also:

setNormalizedOutline(GeneralPath)

getPreferredSize

public SizeD getPreferredSize(IRenderContext context,
                              IPort port)

Convenience method that determines the preferred RenderSize of the port if this style was applied.

Parameters:

context - The context for which the size should be calculated.

port - The port to determine the preferred size of.

Returns:

The preferred size.

getRenderer

public final TemplatePortStyleRenderer getRenderer()

Description copied from interface: IPortStyle

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

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

Specified by:

getRenderer in interface IPortStyle

Returns:

The Renderer.

getRenderSize

public final SizeD getRenderSize()

Gets the SizeD of a port that will be displayed using the created control.

This size will be used to arrange the control correctly.

The default value is (5,5).

Returns:

The RenderSize.

See Also:

setRenderSize(SizeD)

getStyle

protected URL getStyle(IRenderContext context,
                       IModelItem port)

Callback method that determines the Style for the Node.

Parameters:

context - The context for which the style is needed.

port - The port 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(String)

setNormalizedOutline

public final void setNormalizedOutline(GeneralPath value)

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

The shape will automatically be arranged and transformed to have the bounds of the port. 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.

The default value is null.

Parameters:

value - The NormalizedOutline to set.

See Also:

getNormalizedOutline()

setRenderSize

public final void setRenderSize(SizeD value)

Sets the SizeD of a port that will be displayed using the created control.

This size will be used to arrange the control correctly.

The default value is (5,5).

Parameters:

value - The RenderSize to set.

See Also:

getRenderSize()

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