com.yworks.yfiles.graph.styles

Class AbstractStripeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.AbstractStripeStyle

All Implemented Interfaces:

IStripeStyle, ICloneable, Cloneable

public abstract class AbstractStripeStyle
extends Object
implements IStripeStyle, Cloneable

An abstract base class that makes it possible to easily implement a custom IStripeStyle.

The only method that needs to be implemented by subclasses is createVisual(IRenderContext, IStripe), however to improve rendering performance it is highly recommended to implement at least updateVisual(IRenderContext, Node, IStripe), too.

This implementation differs from the straightforward IStripeStyle implementation in that there is no visible separation between the style and its IStripeStyleRenderer. Instead the renderer used by the base class is fixed and delegates all calls back to the style instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStripeStyle() Initializes a new instance of the AbstractStripeStyle class.

Method Summary

Modifier and Type	Method and Description
AbstractStripeStyle	clone() Creates a new object that is a copy of the current instance.
protected abstract Node	createVisual(IRenderContext context, IStripe stripe) Callback that creates the visual.
IStripeStyleRenderer	getRenderer() Gets the renderer implementation for this instance.
protected Object	lookup(IStripe stripe, Class type) Performs the ILookup.lookup(Class) operation for the IStripeStyleRenderer.getContext(IStripe, IStripeStyle) that has been queried from the Renderer.
protected Node	updateVisual(IRenderContext context, Node oldVisual, IStripe stripe) Callback that updates the visual previously created by createVisual(IRenderContext, IStripe).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStripeStyle

protected AbstractStripeStyle()

Initializes a new instance of the AbstractStripeStyle class.

Method Detail

clone

public AbstractStripeStyle clone()

Creates a new object that is a copy of the current instance.

Immutable subclasses should consider returning this.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A new object that is a copy of this instance using Object.clone().

See Also:

Object.clone()

createVisual

protected abstract Node createVisual(IRenderContext context,
                                     IStripe stripe)

Callback that creates the visual.

This method is called in response to a IVisualCreator.createVisual(IRenderContext) call to the instance that has been queried from the Renderer.

Parameters:

stripe - The stripe to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

updateVisual(IRenderContext, Node, IStripe)

getRenderer

public final IStripeStyleRenderer getRenderer()

Gets the renderer implementation for this instance.

The private implementation will delegate all API calls back to this instance.

Specified by:

getRenderer in interface IStripeStyle

Returns:

The Renderer.

lookup

protected Object lookup(IStripe stripe,
                        Class type)

Performs the ILookup.lookup(Class) operation for the IStripeStyleRenderer.getContext(IStripe, IStripeStyle) that has been queried from the Renderer.

This implementation yields null for everything but:

• IVisualCreator
• ILookup

For these interfaces an implementation will be returned that delegates to the methods in this instance.

Parameters:

stripe - The stripe to use for the context lookup.

type - The type to query.

Returns:

An implementation of the type or null.

updateVisual

protected Node updateVisual(IRenderContext context,
                            Node oldVisual,
                            IStripe stripe)

Callback that updates the visual previously created by createVisual(IRenderContext, IStripe).

This method is called in response to a IVisualCreator.updateVisual(IRenderContext, Node) call to the instance that has been queried from the Renderer. This implementation simply delegates to createVisual(IRenderContext, IStripe) so subclasses should override to improve rendering performance.

Parameters:

oldVisual - The visual that has been created in the call to createVisual(IRenderContext, IStripe).

stripe - The stripe to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

createVisual(IRenderContext, IStripe)