com.yworks.yfiles.graph.styles

Class TemplateStripeStyle

java.lang.Object

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

com.yworks.yfiles.graph.styles.TemplateStripeStyle

All Implemented Interfaces:

IStripeStyle, ICloneable, Cloneable

public class TemplateStripeStyle
extends AbstractTemplateStyle<IStripe>
implements IStripeStyle

An IStripeStyle implementation that can render complex Nodes for the visualization of IStripes using a TemplateStripeStyleRenderer.

This style implementation provides the ability to use the control templating mechanism to create the rendering for stripes. The StyleResourceKey is used to determine the Style that will be applied to the Node. The style will be looked-up in the CanvasControls the style is used in.

Constructor Summary

Constructors

Constructor and Description
TemplateStripeStyle() Creates a new instance with no style resource key and TemplateStripeStyleRenderer as renderer.
TemplateStripeStyle(String styleResourceKey) Creates a new instance using the given resource key and TemplateStripeStyleRenderer as renderer.
TemplateStripeStyle(String styleResourceKey, TemplateStripeStyleRenderer 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, IStripe stripe) Factory method that is called by the TemplateStripeStyleRenderer to create the control that will be used for the display of the stripe.
TemplateStripeStyleRenderer	getRenderer() Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given stripe and this style instance.
protected Object	getStyle(IRenderContext context, IModelItem stripe) Callback method that determines the Style for the Node.
String	getStyleResourceKey() Gets the String that will be used to look up the Style that is applied to the Node.
void	setStyleResourceKey(String value) Sets the String that will be used to look up the Style that is applied to the Node.

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

TemplateStripeStyle

public TemplateStripeStyle()

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

TemplateStripeStyle

public TemplateStripeStyle(String styleResourceKey)

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

Parameters:

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

TemplateStripeStyle

public TemplateStripeStyle(String styleResourceKey,
                           TemplateStripeStyleRenderer 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,
                          IStripe stripe)

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

Parameters:

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

stripe - The stripe that will be rendered.

Returns:

The readily styled control.

getRenderer

public final TemplateStripeStyleRenderer getRenderer()

Description copied from interface: IStripeStyle

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

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

Specified by:

getRenderer in interface IStripeStyle

Returns:

The Renderer.

getStyle

protected Object getStyle(IRenderContext context,
                          IModelItem stripe)

Callback method that determines the Style for the Node.

Parameters:

context - The context for which the style is needed.

stripe - The stripe 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 Style that is applied to the Node.

Returns:

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

See Also:

setStyleResourceKey(String)

setStyleResourceKey

public final void setStyleResourceKey(String value)

Sets the String that will be used to look up the Style that is applied to the Node.

Parameters:

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

See Also:

getStyleResourceKey()