com.yworks.yfiles.graph.styles

Class ShapeNodeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.ShapeNodeStyleRenderer

All Implemented Interfaces:

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

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

Default renderer implementation that can be used for ShapeNodeStyle instances.

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeNodeStyleRenderer	INSTANCE A shared immutable instance of this class.

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

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) This method is called by the framework to create a Node that will be included into the IRenderContext.
RectD	getBounds(ICanvasContext context) Returns the layout bounds as an upper bound for the painting bound.
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
ILookup	getContext(INode node, INodeStyle style) Configures the style and node parameters, does not call configure() and returns this.
IHitTestable	getHitTestable(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
PointD	getIntersection(PointD inner, PointD outer) Returns the intersection for the given line with this shape's geometry.
IRectangle	getLayout() Returns the Layout of the node this renderer is currently configured for.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
protected INode	getNode() Gets the currently configured node.
GeneralPath	getOutline() Returns the outline of the shape or null.
protected Paint	getPaint() Get the brush that is currently used by this renderer.
protected Pen	getPen() Get the pen that is currently used by this renderer.
double	getRoundRectArcRadius() Gets the radius that is used to draw rounded edges.
protected ShapeNodeShape	getShape() Get the shape that is currently used by this renderer.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Configures the Style and Node properties, calls configure() and returns this.
protected ShapeNodeStyle	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) Determines if something has been hit at the given coordinates in the world coordinate system.
boolean	isInBox(IInputModeContext context, RectD rectangle) Tests the node using the current Style for an intersection with the given box.
boolean	isInside(PointD location) Checks whether the given coordinate is deemed to lie within the shape's geometric bounds.
boolean	isVisible(ICanvasContext context, RectD rectangle) Determines visibility by checking for an intersection with the Layout.
<TLookup> TLookup	lookup(Class<TLookup> type) Implements the ILookup interface.
protected void	setNode(INode value) Sets the currently configured node.
void	setRoundRectArcRadius(double value) Sets the radius that is used to draw rounded edges.
protected void	setStyle(ShapeNodeStyle value) Sets the currently configured style.
Node	updateVisual(IRenderContext context, Node oldVisual) This method updates or replaces a previously created Node for inclusion in the IRenderContext.

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

Field Detail

INSTANCE

public static final ShapeNodeStyleRenderer INSTANCE

A shared immutable instance of this class.

Trying to modify the properties of this instance will trigger exceptions. Note that instances of this class are not thread safe.

Constructor Detail

ShapeNodeStyleRenderer

public ShapeNodeStyleRenderer()

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

Description copied from interface: IVisualCreator

This method is called by the framework to create a Node that will be included into the IRenderContext.

CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

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)

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

Specified by:

getBoundsProvider in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the bounds provider 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:

getBounds(ICanvasContext)

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)

getHitTestable

public IHitTestable getHitTestable(INode node,
                                   INodeStyle style)

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

Specified by:

getHitTestable in interface INodeStyleRenderer

Parameters:

node - The node to query hit test with. 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:

isHit(IInputModeContext, PointD)

getIntersection

public PointD getIntersection(PointD inner,
                              PointD outer)

Description copied from interface: IShapeGeometry

Returns the intersection for the given line with this shape's geometry.

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)

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

Specified by:

getMarqueeTestable in interface INodeStyleRenderer

Parameters:

node - The node to query marquee intersection 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:

isInBox(IInputModeContext, RectD)

getNode

protected final INode getNode()

Gets the currently configured node.

Returns:

The Node.

See Also:

setNode(INode)

getOutline

public GeneralPath getOutline()

Description copied from interface: IShapeGeometry

Returns the outline of the shape or null.

Specified by:

getOutline in interface IShapeGeometry

Returns:

The outline or null if no outline can be provided.

getPaint

protected Paint getPaint()

Get the brush that is currently used by this renderer.

This implementation retrieves the brush from the owning style

Returns:

The brush that is currently used by this renderer.

getPen

protected Pen getPen()

Get the pen that is currently used by this renderer.

This implementation retrieves the pen from the owning style

Returns:

The pen that is currently used by this renderer.

getRoundRectArcRadius

public double getRoundRectArcRadius()

Gets the radius that is used to draw rounded edges.

Returns:

The RoundRectArcRadius.

See Also:

setRoundRectArcRadius(double)

getShape

protected final ShapeNodeShape getShape()

Get the shape that is currently used by this renderer.

This implementation retrieves the shape from the owning style

Returns:

The shape that is currently used by this renderer.

getShapeGeometry

public IShapeGeometry getShapeGeometry(INode node,
                                       INodeStyle style)

Configures the Style and Node properties, calls configure() and returns this.

Specified by:

getShapeGeometry in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the shape geometry 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:

isInside(PointD), getIntersection(PointD, PointD)

getStyle

protected final ShapeNodeStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(ShapeNodeStyle)

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)

Description copied from interface: IHitTestable

Determines if something has been hit at the given coordinates in the world coordinate system.

Implementations should inspect the HitTestRadius and take the value into account when performing hit tests. This allows the user to hit elements even if the zoom level is very small and allows for accurate hit tests at greater zoom levels.

Specified by:

isHit in interface IHitTestable

Parameters:

context - the context the hit test is performed in

location - the coordinates in world coordinate system

Returns:

whether something has been hit

isInBox

public boolean isInBox(IInputModeContext context,
                       RectD rectangle)

Tests the node using the current Style for an intersection with the given box.

This implementation uses the Layout to determine whether the node is in the box.

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 node is considered to be captured by the marquee

isInside

public boolean isInside(PointD location)

Description copied from interface: IShapeGeometry

Checks whether the given coordinate is deemed to lie within the shape's geometric bounds.

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)

Implements the ILookup interface.

This method will be used by default if getContext(INode, INodeStyle) has been queried for a lookup implementation. Note that it cannot be assumed that configure() has already been invoked. However, normally Node and Style will be correctly configured if invoked directly after GetContext. Subclass implementations should make sure to configure this instance before they return this as a result of a successful lookup. This implementation will check if type.IsInstanceOfType(this) and will call configure() on success and return this.

Specified by:

lookup in interface ILookup

Parameters:

type - The type to query for.

Returns:

An implementation or null.

setNode

protected final void setNode(INode value)

Sets the currently configured node.

Parameters:

value - The Node to set.

See Also:

getNode()

setRoundRectArcRadius

public void setRoundRectArcRadius(double value)

Sets the radius that is used to draw rounded edges.

Parameters:

value - The RoundRectArcRadius to set.

See Also:

getRoundRectArcRadius()

setStyle

protected final void setStyle(ShapeNodeStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public Node updateVisual(IRenderContext context,
                         Node oldVisual)

Description copied from interface: IVisualCreator

This method updates or replaces a previously created Node for inclusion in the IRenderContext.

The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl