com.yworks.yfiles.graph.styles

Class PanelNodeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.PanelNodeStyleRenderer

All Implemented Interfaces:

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

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

A INodeStyle renderer implementation that draws a simple floating panel with a slight gradient, a thin border and a simple drop shadow.

See Also:

PanelNodeStyle

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
PanelNodeStyleRenderer() Creates a new instance of this style.

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.
protected boolean	drawShadow() Determines whether to draw the drop shadow.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
protected Color	getColor() Retrieves the color from the style.
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) Finds an intersection for the current node using the Style.
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 using the node's Layout.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Configures the Style and Node properties, calls configure() and returns this.
protected PanelNodeStyle	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) Hit tests the node using the current Style.
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 lies within the shape's geometric bounds.
boolean	isVisible(ICanvasContext context, RectD rectangle) Determines whether an element might intersect the visible region for a given context.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
protected void	setNode(INode value) Sets the currently configured node.
protected void	setStyle(PanelNodeStyle 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

Constructor Detail

PanelNodeStyleRenderer

public PanelNodeStyleRenderer()

Creates a new instance of this style.

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)

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)

drawShadow

protected boolean drawShadow()

Determines whether to draw the drop shadow.

Returns:

true, always.

getBounds

public RectD getBounds(ICanvasContext context)

Description copied from interface: IBoundsProvider

Returns a tight rectangular area where the whole rendering would fit into.

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return RectD.INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or RectD.EMPTY.

Specified by:

getBounds in interface IBoundsProvider

Parameters:

context - the context to calculate the bounds for

Returns:

the bounds or RectD.EMPTY 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)

getColor

protected Color getColor()

Retrieves the color from the style.

Returns:

The Color.

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)

Finds an intersection for the current node using the Style.

This implementation returns the intersection for the Layout.

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:

True if an intersection was actually 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()

Returns the outline of the shape using the node's Layout.

Specified by:

getOutline in interface IShapeGeometry

Returns:

The outline of the bounds of the node.

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 PanelNodeStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(PanelNodeStyle)

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)

Hit tests the node using the current Style.

This implementation uses the Layout to determine whether the node has been hit. The check is delegated to RectD.contains(PointD, double) using HitTestRadius as the last argument.

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)

Checks whether the given coordinate lies within the shape's geometric bounds.

This implementation checks for containment in the Layout.

Specified by:

isInside in interface IShapeGeometry

Parameters:

location - The point to test.

Returns:

True if the point lies within the geometry of the rendering.

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Description copied from interface: IVisibilityTestable

Determines whether an element might intersect the visible region for a given context.

Conservative implementations can always return true.

Specified by:

isVisible in interface IVisibilityTestable

Parameters:

context - The context to determine the visibility for.

rectangle - The visible region clip.

Returns:

false if and only if it is safe not to paint the element because it would not affect the given clipping region.

lookup

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

Description copied from interface: ILookup

Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Specified by:

lookup in interface ILookup

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type 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(PanelNodeStyle 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