com.yworks.yfiles.graph.styles

Class AbstractPortStyle

java.lang.Object

com.yworks.yfiles.graph.styles.AbstractPortStyle

All Implemented Interfaces:

IPortStyle, ICloneable, Cloneable

public abstract class AbstractPortStyle
extends Object
implements IPortStyle, Cloneable

An abstract base class that makes it possible to easily implement a custom IPortStyle.

Only createVisual(IRenderContext, IPort) and getBounds(ICanvasContext, IPort) need to be implemented by subclasses, however to improve rendering performance it is highly recommended to implement at least updateVisual(IRenderContext, Node, IPort), too.

This implementation differs from the straightforward IPortStyle implementation in that there is no visible separation between the style and its IPortStyleRenderer. Instead the renderer used by the base class is fixed and delegates all calls back to the style instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPortStyle() Initializes a new instance of the AbstractPortStyle class.

Method Summary

Modifier and Type	Method and Description
AbstractPortStyle	clone() Creates a new object that is a copy of the current instance.
protected abstract Node	createVisual(IRenderContext context, IPort port) Callback that creates the visual.
protected abstract RectD	getBounds(ICanvasContext context, IPort port) Callback that returns the bounds of the visual for the port in the given context.
IPortStyleRenderer	getRenderer() Gets the renderer implementation for this instance.
protected boolean	isHit(IInputModeContext context, PointD location, IPort port) Determines whether the visual representation of the port has been hit at the given location.
protected boolean	isInBox(IInputModeContext context, RectD rectangle, IPort port) Determines whether the visualization for the specified port is included in the marquee selection.
protected boolean	isVisible(ICanvasContext context, RectD rectangle, IPort port) Determines whether the visualization for the specified port is visible in the context.
protected Object	lookup(IPort port, Class type) Performs the ILookup.lookup(Class) operation for the IPortStyleRenderer.getContext(IPort, IPortStyle) that has been queried from the Renderer.
protected Node	updateVisual(IRenderContext context, Node oldVisual, IPort port) Callback that updates the visual previously created by createVisual(IRenderContext, IPort).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPortStyle

protected AbstractPortStyle()

Initializes a new instance of the AbstractPortStyle class.

Method Detail

clone

public AbstractPortStyle clone()

Creates a new object that is a copy of the current instance.

Immutable subclasses should consider returning this.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A new object that is a copy of this instance using Object.clone().

See Also:

Object.clone()

createVisual

protected abstract Node createVisual(IRenderContext context,
                                     IPort port)

Callback that creates the visual.

This method is called in response to a IVisualCreator.createVisual(IRenderContext) call to the instance that has been queried from the Renderer.

Parameters:

context - The render context.

port - The port to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

updateVisual(IRenderContext, Node, IPort)

getBounds

protected abstract RectD getBounds(ICanvasContext context,
                                   IPort port)

Callback that returns the bounds of the visual for the port in the given context.

Parameters:

context - The canvas context.

port - The port to which this style instance is assigned.

Returns:

The visual bounds of the visual representation.

getRenderer

public final IPortStyleRenderer getRenderer()

Gets the renderer implementation for this instance.

The private implementation will delegate all API calls back to this instance.

Specified by:

getRenderer in interface IPortStyle

Returns:

The Renderer.

isHit

protected boolean isHit(IInputModeContext context,
                        PointD location,
                        IPort port)

Determines whether the visual representation of the port has been hit at the given location.

This method is called in response to a IHitTestable.isHit(IInputModeContext, PointD) call to the instance that has been queried from the Renderer.

This implementation uses the bounds to determine whether the port has been hit.

Parameters:

context - The input mode context.

location - The point to test.

port - The port to which this style instance is assigned.

Returns:

true if the specified port representation is hit; false otherwise.

isInBox

protected boolean isInBox(IInputModeContext context,
                          RectD rectangle,
                          IPort port)

Determines whether the visualization for the specified port is included in the marquee selection.

This method is called in response to a IMarqueeTestable.isInBox(IInputModeContext, RectD) call to the instance that has been queried from the Renderer.

This implementation simply tests whether the bounds intersect the marquee box.

Parameters:

context - The input mode context.

rectangle - The marquee selection box.

port - The port to which this style instance is assigned.

Returns:

true if the specified port is visible is selected by the marquee rectangle; false otherwise.

isVisible

protected boolean isVisible(ICanvasContext context,
                            RectD rectangle,
                            IPort port)

Determines whether the visualization for the specified port is visible in the context.

This method is called in response to a IVisibilityTestable.isVisible(ICanvasContext, RectD) call to the instance that has been queried from the Renderer. This implementation simply tests whether the bounds intersect the clip.

Parameters:

context - The canvas context.

rectangle - The clipping rectangle.

port - The port to which this style instance is assigned.

Returns:

true if the specified port is visible in the clipping rectangle; false otherwise.

lookup

protected Object lookup(IPort port,
                        Class type)

Performs the ILookup.lookup(Class) operation for the IPortStyleRenderer.getContext(IPort, IPortStyle) that has been queried from the Renderer.

This implementation yields null for everything but:

• IHitTestable
• IVisualCreator
• IBoundsProvider
• IVisibilityTestable
• IMarqueeTestable
• ILookup

For these interfaces an implementation will be returned that delegates to the methods in this instance.

Parameters:

port - The port to use for the context lookup.

type - The type to query.

Returns:

An implementation of the type or null.

updateVisual

protected Node updateVisual(IRenderContext context,
                            Node oldVisual,
                            IPort port)

Callback that updates the visual previously created by createVisual(IRenderContext, IPort).

This method is called in response to a IVisualCreator.updateVisual(IRenderContext, Node) call to the instance that has been queried from the Renderer. This implementation simply delegates to createVisual(IRenderContext, IPort) so subclasses should override to improve rendering performance.

Parameters:

context - The render context.

oldVisual - The visual that has been created in the call to createVisual(IRenderContext, IPort).

port - The port to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

createVisual(IRenderContext, IPort)