com.yworks.yfiles.graph.styles

Class TableNodeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.TableNodeStyleRenderer

All Implemented Interfaces:

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

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

Default renderer implementation that can be used for TableNodeStyle instances.

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

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 INodeStyle	getBackgroundStyle() Get the background style that is currently used by this renderer.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Gets an implementation of the IBoundsProvider interface that can handle the provided node and its associated style.
ILookup	getContext(INode node, INodeStyle style) Gets a temporary context instance that can be used to query additional information for the node's style.
IHitTestable	getHitTestable(INode node, INodeStyle style) Gets an implementation of the IHitTestable interface that can handle the provided node and its associated style.
PointD	getIntersection(PointD inner, PointD outer) Returns the intersection for the given line with this shape's geometry.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Gets an implementation of the IMarqueeTestable interface that can handle the provided node and its associated style.
protected INode	getNode() Gets the currently configured node.
GeneralPath	getOutline() Returns the outline of the shape or null.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Gets an implementation of the IShapeGeometry interface that can handle the provided node and its associated style.
protected TableNodeStyle	getStyle() Gets the currently configured style.
protected ITable	getTable() Gets the table object that should be used for rendering.
protected TableRenderingOrder	getTableRenderingOrder() Get the TableRenderingOrder that is currently used by this renderer.
IVisibilityTestable	getVisibilityTestable(INode node, INodeStyle style) Gets an implementation of the IVisibilityTestable interface that can handle the provided node and its associated style.
IVisualCreator	getVisualCreator(INode node, INodeStyle style) Gets an implementation of the IVisualCreator interface that can handle the provided node and its associated style.
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) This callback returns true if the corresponding item is considered to intersect the given rectangular 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 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(TableNodeStyle 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

TableNodeStyleRenderer

public TableNodeStyleRenderer()

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)

getBackgroundStyle

protected INodeStyle getBackgroundStyle()

Get the background style that is currently used by this renderer.

This implementation retrieves the BackgroundStyle from the owning style

Returns:

The background style that is currently used by this renderer.

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)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IBoundsProvider interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Specified by:

getBoundsProvider in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the calculating the painting bounds

Returns:

An implementation that may be used to subsequently query the node's painting bounds. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getContext

public ILookup getContext(INode node,
                          INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets a temporary context instance that can be used to query additional information for the node's style.

Implementations may return ILookup.EMPTY if they don't support this, but may not return null.

Specified by:

getContext in interface INodeStyleRenderer

Parameters:

node - The node to provide a context instance for.

style - The style to use for the context.

Returns:

An non-null lookup implementation.

See Also:

ILookup.EMPTY, ILookup

getHitTestable

public IHitTestable getHitTestable(INode node,
                                   INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IHitTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Specified by:

getHitTestable in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the querying hit tests

Returns:

An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return null to indicate that the node cannot be hit tested.

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.

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(INode node,
                                           INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IMarqueeTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Specified by:

getMarqueeTestable in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the querying marquee intersection test.

Returns:

An implementation that may be used to subsequently query the marquee intersections. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

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.

getShapeGeometry

public IShapeGeometry getShapeGeometry(INode node,
                                       INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IShapeGeometry interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Specified by:

getShapeGeometry in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the rendering

Returns:

An implementation that may be used to subsequently query geometry information from. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getStyle

protected final TableNodeStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(TableNodeStyle)

getTable

protected ITable getTable()

Gets the table object that should be used for rendering.

This implementation delegates to the Table provided by the Table property.

Returns:

The table that should be used for the rendering process.

getTableRenderingOrder

protected TableRenderingOrder getTableRenderingOrder()

Get the TableRenderingOrder that is currently used by this renderer.

This implementation retrieves the TableRenderingOrder from the owning style

Returns:

The TableRenderingOrder that is currently used by this renderer.

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(INode node,
                                                 INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IVisibilityTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Specified by:

getVisibilityTestable in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the testing the visibility

Returns:

An implementation that may be used to subsequently query the node's visibility. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getVisualCreator

public IVisualCreator getVisualCreator(INode node,
                                       INodeStyle style)

Description copied from interface: INodeStyleRenderer

Gets an implementation of the IVisualCreator interface that can handle the provided node and its associated style.

This method may return a flyweight implementation, but never null.

Specified by:

getVisualCreator in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the creation of the visual

Returns:

An implementation that may be used to subsequently create or update the visual for the node. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may not return null but should yield a void implementation instead.

See Also:

VoidVisualCreator.INSTANCE

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)

Description copied from interface: IMarqueeTestable

This callback returns true if the corresponding item is considered to intersect the given rectangular box.

This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.

Implementations should respect the HitTestRadius if marquee selections should behave differently on different zoom levels.

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)

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)

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(TableNodeStyle 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