com.yworks.yfiles.graph.styles

Class TemplateStripeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.TemplateStripeStyleRenderer

All Implemented Interfaces:

ILookup, IStripeStyleRenderer, IVisualCreator

public class TemplateStripeStyleRenderer
extends Object
implements IStripeStyleRenderer, ILookup, IVisualCreator

An implementation of the IStripeStyleRenderer interface that can render TemplateStripeStyle instances.

See Also:

TemplateStripeStyle

Field Summary

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Constructor Summary

Constructors

Constructor and Description
TemplateStripeStyleRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Prepares this instance for subsequent calls after the style and stripe have been initialized.
Node	createVisual(IRenderContext context) Creates the visual by delegating to TemplateStripeStyle.createControl(IRenderContext, IStripe) and then initializing the control with the context.
ILookup	getContext(IStripe stripe, IStripeStyle style) Configures the style and stripe parameters, does not call configure() and returns this.
protected IContextLookup	getContextLookup(TemplateStripeStyle style) Gets the context by delegating to ContextLookup.
IRectangle	getLayout() Returns the Layout of the stripe this renderer is currently configured for.
protected IStripe	getStripe() Gets the currently configured stripe.
protected TemplateStripeStyle	getStyle() Gets the currently configured style.
IVisualCreator	getVisualCreator(IStripe stripe, IStripeStyle style) Configures the style and stripe parameters, calls configure() and returns this.
<TLookup> TLookup	lookup(Class<TLookup> type) Implementation of the ILookup.lookup(Class) method.
protected void	setStripe(IStripe value) Sets the currently configured stripe.
protected void	setStyle(TemplateStripeStyle value) Sets the currently configured style.
Node	updateVisual(IRenderContext context, Node oldVisual) Updates the Node correspondingly.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

Constructor Detail

TemplateStripeStyleRenderer

public TemplateStripeStyleRenderer()

Method Detail

configure

protected void configure()

Prepares this instance for subsequent calls after the style and stripe have been initialized.

Upon invocation the Style and Stripe properties have been populated by the getVisualCreator(IStripe, IStripeStyle) or getContext(IStripe, IStripeStyle) methods.

This is an empty implementation. Subclasses might have to override this method.

createVisual

public Node createVisual(IRenderContext context)

Creates the visual by delegating to TemplateStripeStyle.createControl(IRenderContext, IStripe) and then initializing the control with the context.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context for the creation.

Returns:

The control that is used for rendering the stripe.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

getContext

public ILookup getContext(IStripe stripe,
                          IStripeStyle style)

Configures the style and stripe parameters, does not call configure() and returns this.

As this method may be called often it will not automatically call configure(), instead subclasses should ensure that in the lookup(Class) method call they should call configure() only if needed, i.e. if they decide to return this or an instance that depends on a correctly configured this.

Specified by:

getContext in interface IStripeStyleRenderer

Parameters:

stripe - The stripe to query the context for. The value will be stored in the Stripe property.

style - The style to associate with the stripe. The value will be stored in the Style property.

Returns:

this

See Also:

lookup(Class)

getContextLookup

protected IContextLookup getContextLookup(TemplateStripeStyle style)

Gets the context by delegating to ContextLookup.

getLayout

public final IRectangle getLayout()

Returns the Layout of the stripe this renderer is currently configured for.

Returns Stripe.Layout.

Returns:

The Layout.

getStripe

protected final IStripe getStripe()

Gets the currently configured stripe.

Returns:

The Stripe.

See Also:

setStripe(IStripe)

getStyle

protected final TemplateStripeStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(TemplateStripeStyle)

getVisualCreator

public IVisualCreator getVisualCreator(IStripe stripe,
                                       IStripeStyle style)

Configures the style and stripe parameters, calls configure() and returns this.

Specified by:

getVisualCreator in interface IStripeStyleRenderer

Parameters:

stripe - The stripe to retrieve the IVisualCreator for. The value will be stored in the Stripe property.

style - The style to associate with the stripe. The value will be stored in the Style property.

Returns:

this

See Also:

createVisual(IRenderContext), updateVisual(IRenderContext, Node)

lookup

public <TLookup> TLookup lookup(Class<TLookup> type)

Implementation of the ILookup.lookup(Class) method.

Delegates to the lookup returned by getContextLookup(TemplateStripeStyle), first. Last, it returns this class if it implements the queried type.

Specified by:

lookup in interface ILookup

Parameters:

type - The type to query an instance for.

Returns:

The implementation or null.

setStripe

protected final void setStripe(IStripe value)

Sets the currently configured stripe.

Parameters:

value - The Stripe to set.

See Also:

getStripe()

setStyle

protected final void setStyle(TemplateStripeStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public Node updateVisual(IRenderContext context,
                         Node oldVisual)

Updates the Node correspondingly.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context for the creation.

oldVisual - The currently rendered visual.

Returns:

The control that is used for rendering the stripe.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl