com.yworks.yfiles.graph.styles

Class TemplateLabelStyle

java.lang.Object

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

com.yworks.yfiles.graph.styles.TemplateLabelStyle

All Implemented Interfaces:

ILabelStyle, ICloneable, Cloneable

public class TemplateLabelStyle
extends AbstractTemplateStyle<ILabel>
implements ILabelStyle

An ILabelStyle implementation that can render complex Nodes for the visualization of ILabels using TemplateLabelStyleRenderer.

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.

Constructor Summary

Constructors

Constructor and Description
TemplateLabelStyle() Creates a new instance with no style resource key and TemplateLabelStyleRenderer as renderer.
TemplateLabelStyle(String styleResourceKey) Creates a new instance using the given resource key and TemplateLabelStyleRenderer as renderer.
TemplateLabelStyle(String styleResourceKey, TemplateLabelStyleRenderer 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, ILabel label) Factory method that is called by the TemplateLabelStyleRenderer to create the control that will be used for the display of the label.
GeneralPath	getNormalizedOutline() Gets the normalized outline of a label that will be displayed using the created control.
SizeD	getPreferredSize(IRenderContext context, ILabel label) Convenience method that determines the preferred size of the label if this style was applied.
TemplateLabelStyleRenderer	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.
protected URL	getStyle(IRenderContext context, IModelItem label) 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.
boolean	isAutoFlippingEnabled() Gets a value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down.
void	setAutoFlippingEnabled(boolean value) Sets a value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down.
void	setNormalizedOutline(GeneralPath value) Sets the normalized outline of a label 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

TemplateLabelStyle

public TemplateLabelStyle()

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

TemplateLabelStyle

public TemplateLabelStyle(String styleResourceKey)

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

Parameters:

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

TemplateLabelStyle

public TemplateLabelStyle(String styleResourceKey,
                          TemplateLabelStyleRenderer 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,
                          ILabel label)

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

Parameters:

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

label - The label that will be rendered.

Returns:

The readily styled control.

getNormalizedOutline

public final GeneralPath getNormalizedOutline()

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

The shape will automatically arranged and transformed to have the bounds of the label. 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,
                              ILabel label)

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

Parameters:

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

label - The label to determine the preferred size of.

Returns:

The preferred size.

getRenderer

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

getStyle

protected URL getStyle(IRenderContext context,
                       IModelItem label)

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

Parameters:

context - The context for which the style is needed.

label - The label 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.

Returns:

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

See Also:

setStyleResourceKey(java.lang.String)

isAutoFlippingEnabled

public final boolean isAutoFlippingEnabled()

Gets a value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down.

The default value is true.

Returns:

true if labels should be flipped automatically; false otherwise.

See Also:

setAutoFlippingEnabled(boolean)

setAutoFlippingEnabled

public final void setAutoFlippingEnabled(boolean value)

Sets a value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down.

The default value is true.

Parameters:

value - true if labels should be flipped automatically; false otherwise.

See Also:

isAutoFlippingEnabled()

setNormalizedOutline

public final void setNormalizedOutline(GeneralPath value)

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

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

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