com.yworks.yfiles.graph.styles

Class TemplateNodeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.TemplateNodeStyleRenderer

All Implemented Interfaces:

ILookup, INodeStyleRenderer, IShapeGeometry, IBoundsProvider, IHitTestable, IMarqueeTestable, IVisibilityTestable, IVisualCreator

public class TemplateNodeStyleRenderer
extends Object
implements INodeStyleRenderer, IShapeGeometry, IBoundsProvider, IVisibilityTestable, IMarqueeTestable, IHitTestable, ILookup, IVisualCreator

An implementation of the INodeStyleRenderer interface that can render TemplateNodeStyle instances.

See Also:

TemplateNodeStyle

Field Summary

Fields inherited from interface com.yworks.yfiles.view.IBoundsProvider

EMPTY, UNBOUNDED

Fields inherited from interface com.yworks.yfiles.view.IVisibilityTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IMarqueeTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IHitTestable

ALWAYS, NEVER

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
TemplateNodeStyleRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Prepares this instance for subsequent calls after the style and node have been initialized.
Node	createVisual(IRenderContext context) Creates the visual by delegating to TemplateNodeStyle.createControl(IRenderContext, INode) and then initializing the control with the context.
RectD	getBounds(ICanvasContext context) Returns the layout bounds as an upper bound for the painting bound.
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Provides a bounds calculation implementation for the given style and node.
ILookup	getContext(INode node, INodeStyle style) Configures the style and node parameters, does not call configure() and returns this.
protected IContextLookup	getContextLookup(TemplateNodeStyle style) Gets the context by delegating to ContextLookup.
IHitTestable	getHitTestable(INode node, INodeStyle style) Provides a hit testing implementation for the given style and node.
protected InsetsD	getInsets(TemplateNodeStyle style) Gets the insets by delegating to Insets.
PointD	getIntersection(PointD inner, PointD outer) Tries to use the outline shape to perform the intersection calculation, otherwise reverts to default (rectangular) behavior.
IRectangle	getLayout() Returns the Layout of the node this renderer is currently configured for.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Provides a marquee testing implementation for the given style and node.
protected SizeD	getMinimumSize(TemplateNodeStyle style) Gets the minimum size by delegating to MinimumSize.
protected INode	getNode() Gets the currently configured node.
protected GeneralPath	getNormalizedOutline(TemplateNodeStyle style) Gets the normalized outline by delegating to NormalizedOutline.
GeneralPath	getOutline() Tries to use the outline shape to create the outline shape path, otherwise reverts to default (rectangular) behavior.
SizeD	getPreferredSize(INode node, INodeStyle style) Calculates the preferred size for the given node and style.
protected SizeD	getPreferredSize(IRenderContext context) Calculates the preferred size given the current state of the renderer for the given context.
SizeD	getPreferredSize(IRenderContext context, INode node, INodeStyle style) Calculates the preferred size for the given node and style in the provided context.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Provides the geometry for the visual representation.
protected TemplateNodeStyle	getStyle() Gets the currently configured style.
IVisibilityTestable	getVisibilityTestable(INode node, INodeStyle style) Configures the style and node parameters, does not call configure() and returns this.
IVisualCreator	getVisualCreator(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
boolean	isHit(IInputModeContext context, PointD location) Tries to use the outline shape to perform the hit test analysis, otherwise reverts to default (rectangular) behavior.
boolean	isInBox(IInputModeContext context, RectD rectangle) Tries to use the outline shape to perform the marquee intersection analysis, otherwise reverts to default (rectangular) behavior.
boolean	isInside(PointD location) Tries to use the outline shape to perform the contains test, otherwise reverts to default (rectangular) behavior.
boolean	isVisible(ICanvasContext context, RectD rectangle) Determines visibility by checking for an intersection with the Layout.
<TLookup> TLookup	lookup(Class<TLookup> type) Implementation of the ILookup.lookup(Class) method.
protected void	setNode(INode value) Sets the currently configured node.
protected void	setStyle(TemplateNodeStyle 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.view.IBoundsProvider

fromRectangle

Methods inherited from interface com.yworks.yfiles.view.input.IHitTestable

create

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

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

Constructor Detail

TemplateNodeStyleRenderer

public TemplateNodeStyleRenderer()

Method Detail

configure

protected void configure()

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

Upon invocation the Style and Node properties have been populated by the getVisualCreator(INode, INodeStyle), getBoundsProvider(INode, INodeStyle), getHitTestable(INode, INodeStyle), or getMarqueeTestable(INode, INodeStyle) 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 TemplateNodeStyle.createControl(IRenderContext, INode) 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 node.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

getBounds

public RectD getBounds(ICanvasContext context)

Returns the layout bounds as an upper bound for the painting bound.

This implementation simply sets the Layout's bounds to the scratch variable and returns.

Specified by:

getBounds in interface IBoundsProvider

Parameters:

context - the context to calculate the bounds for

Returns:

the bounds or null to indicate an unbound area

getBoundsProvider

public IBoundsProvider getBoundsProvider(INode node,
                                         INodeStyle style)

Provides a bounds calculation implementation for the given style and node.

If ContextLookup provides an implementation of the IBoundsProvider interface than this instance will be returned, otherwise the default (rectangular) behavior will be used.

Specified by:

getBoundsProvider in interface INodeStyleRenderer

Parameters:

node - The node to query the provider for.

style - The style whose provider is queried.

Returns:

An implementation that can calculate visual bounds.

getContext

public ILookup getContext(INode node,
                          INodeStyle style)

Configures the style and node 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 INodeStyleRenderer

Parameters:

node - The node to query the context for. The value will be stored in the Node property.

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

Returns:

this

See Also:

lookup(Class)

getContextLookup

protected IContextLookup getContextLookup(TemplateNodeStyle style)

Gets the context by delegating to ContextLookup.

getHitTestable

public IHitTestable getHitTestable(INode node,
                                   INodeStyle style)

Provides a hit testing implementation for the given style and node.

If ContextLookup provides an implementation of the IHitTestable interface than this instance will be returned, otherwise the outline shape will be used to perform the hit testing.

Specified by:

getHitTestable in interface INodeStyleRenderer

Parameters:

node - The node to query the tester for.

style - The style whose tester is queried.

Returns:

An implementation that can perform the hit testing.

See Also:

isHit(IInputModeContext, PointD)

getInsets

protected InsetsD getInsets(TemplateNodeStyle style)

Gets the insets by delegating to Insets.

getIntersection

public PointD getIntersection(PointD inner,
                              PointD outer)

Tries to use the outline shape to perform the intersection calculation, otherwise reverts to default (rectangular) behavior.

Specified by:

getIntersection in interface IShapeGeometry

Parameters:

inner - The first point of the line that is inside the shape.

outer - The second point of the line that is outside the shape.

Returns:

The coordinates of the intersection point, if an intersection was found.

getLayout

public final IRectangle getLayout()

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

Returns Node.Layout.

Returns:

The Layout.

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(INode node,
                                           INodeStyle style)

Provides a marquee testing implementation for the given style and node.

If ContextLookup provides an implementation of the IMarqueeTestable interface than this instance will be returned, otherwise the outline shape will be used to determine the marquee intersection test with the visual representation of the node.

Specified by:

getMarqueeTestable in interface INodeStyleRenderer

Parameters:

node - The node to query the tester for.

style - The style whose tester is queried.

Returns:

An implementation that can test for marquee intersections.

See Also:

isInBox(IInputModeContext, RectD)

getMinimumSize

protected SizeD getMinimumSize(TemplateNodeStyle style)

Gets the minimum size by delegating to MinimumSize.

getNode

protected final INode getNode()

Gets the currently configured node.

Returns:

The Node.

See Also:

setNode(INode)

getNormalizedOutline

protected GeneralPath getNormalizedOutline(TemplateNodeStyle style)

Gets the normalized outline by delegating to NormalizedOutline.

getOutline

public GeneralPath getOutline()

Tries to use the outline shape to create the outline shape path, otherwise reverts to default (rectangular) behavior.

Specified by:

getOutline in interface IShapeGeometry

Returns:

The outline or null if no outline can be provided.

getPreferredSize

public SizeD getPreferredSize(INode node,
                              INodeStyle style)

Calculates the preferred size for the given node and style.

Parameters:

node - The node instance.

style - The style instance to apply.

Returns:

The preferred size for the given label and style.

See Also:

getPreferredSize(IRenderContext)

getPreferredSize

protected SizeD getPreferredSize(IRenderContext context)

Calculates the preferred size given the current state of the renderer for the given context.

Parameters:

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

Returns:

The size as suggested by this renderer.

getPreferredSize

public SizeD getPreferredSize(IRenderContext context,
                              INode node,
                              INodeStyle style)

Calculates the preferred size for the given node and style in the provided context.

Parameters:

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

node - The node instance.

style - The style instance to apply.

Returns:

The preferred size for the given label and style.

See Also:

getPreferredSize(IRenderContext)

getShapeGeometry

public IShapeGeometry getShapeGeometry(INode node,
                                       INodeStyle style)

Provides the geometry for the visual representation.

If ContextLookup provides an implementation of the IShapeGeometry interface than this instance will be returned, otherwise the outline shape will be used to determine the outline of the visual representation of a node.

Specified by:

getShapeGeometry in interface INodeStyleRenderer

Parameters:

node - The node to query the geometry for.

style - The style for which the geometry is queried.

Returns:

An implementation that describes the outline geometry of the shape.

See Also:

isInside(PointD), getOutline()

getStyle

protected final TemplateNodeStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(TemplateNodeStyle)

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(INode node,
                                                 INodeStyle style)

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

Unlike most of the other methods this implementation does not call configure(). If the subclass implementation depends on this instance to be configured, it needs to call Configure in isVisible(ICanvasContext, RectD).

Specified by:

getVisibilityTestable in interface INodeStyleRenderer

Parameters:

node - The node to query visibility tests. The value will be stored in the Node property.

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

Returns:

this

See Also:

isVisible(ICanvasContext, RectD)

getVisualCreator

public IVisualCreator getVisualCreator(INode node,
                                       INodeStyle style)

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

Specified by:

getVisualCreator in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the IVisualCreator for. The value will be stored in the Node property.

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

Returns:

this

See Also:

createVisual(IRenderContext), updateVisual(IRenderContext, Node)

isHit

public boolean isHit(IInputModeContext context,
                     PointD location)

Tries to use the outline shape to perform the hit test analysis, otherwise reverts to default (rectangular) behavior.

Specified by:

isHit in interface IHitTestable

Parameters:

context - the context the hit test is performed in

location - the hit point in world coordinates

Returns:

whether something has been hit

isInBox

public boolean isInBox(IInputModeContext context,
                       RectD rectangle)

Tries to use the outline shape to perform the marquee intersection analysis, otherwise reverts to default (rectangular) behavior.

Specified by:

isInBox in interface IMarqueeTestable

Parameters:

context - the current input mode context

rectangle - the box describing the marquee's bounds

Returns:

true if the item is considered to be captured by the marquee

isInside

public boolean isInside(PointD location)

Tries to use the outline shape to perform the contains test, otherwise reverts to default (rectangular) behavior.

Specified by:

isInside in interface IShapeGeometry

Parameters:

location - The point to test.

Returns:

True if the point lies within the shape.

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Determines visibility by checking for an intersection with the Layout.

Specified by:

isVisible in interface IVisibilityTestable

Parameters:

context - The context.

rectangle - The current clip

Returns:

Whether the Layout is visible in the clip.

lookup

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

Implementation of the ILookup.lookup(Class) method.

Delegates to the lookup returned by getContextLookup(TemplateNodeStyle), first. Returns special INodeInsetsProvider or INodeSizeConstraintProvider implementations if asked for. 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.

setNode

protected final void setNode(INode value)

Sets the currently configured node.

Parameters:

value - The Node to set.

See Also:

getNode()

setStyle

protected final void setStyle(TemplateNodeStyle 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 node.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl