com.yworks.yfiles.graph.styles

Class TemplatePortStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.TemplatePortStyleRenderer

All Implemented Interfaces:

ILookup, IPortStyleRenderer, IBoundsProvider, IHitTestable, IMarqueeTestable, IVisibilityTestable, IVisualCreator

public class TemplatePortStyleRenderer
extends Object
implements IPortStyleRenderer, IBoundsProvider, IVisibilityTestable, IMarqueeTestable, IHitTestable, ILookup, IVisualCreator

An implementation of the IPortStyleRenderer interface that can render TemplatePortStyle instances.

See Also:

TemplatePortStyle

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

Method Summary

Modifier and Type	Method and Description
protected void	arrange(Node portControl) Arranges the port control according to the location of the port and the getRenderSize().
protected void	configure() Prepares this instance for subsequent calls after the style and port have been initialized.
Node	createVisual(IRenderContext context) Creates the visual by delegating to TemplatePortStyle.createControl(IRenderContext, IPort) and then initializing the control with the context.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.
IBoundsProvider	getBoundsProvider(IPort port, IPortStyle style) Configures the style and port parameters, calls configure() and returns this.
protected PointD	getCenter() Gets the center of the port.
ILookup	getContext(IPort port, IPortStyle style) Configures the style and port parameters, does not call configure() and returns this.
IHitTestable	getHitTestable(IPort port, IPortStyle style) Configures the style and port parameters, calls configure() and returns this.
IMarqueeTestable	getMarqueeTestable(IPort port, IPortStyle style) Configures the style and port parameters, calls configure() and returns this.
protected GeneralPath	getNormalizedOutline(TemplatePortStyle style) Gets the normalized outline by delegating to NormalizedOutline.
protected IPort	getPort() Gets the currently configured port.
protected SizeD	getPreferredSize(IRenderContext context) Gets the preferred size for the current configuration.
SizeD	getPreferredSize(IRenderContext context, IPort port, TemplatePortStyle style) Calculates the preferred size for the given port and style.
protected SizeD	getRenderSize() Gets the size of the rendering from the style.
protected TemplatePortStyle	getStyle() Gets the currently configured style.
IVisibilityTestable	getVisibilityTestable(IPort port, IPortStyle style) Configures the style and port parameters, does not call configure() and returns this.
IVisualCreator	getVisualCreator(IPort port, IPortStyle style) Configures the style and port 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) This callback returns true if the corresponding item is considered to intersect the given rectangular box.
boolean	isVisible(ICanvasContext context, RectD rectangle) Calls configure() and test the Port using the Style for a visible intersection with the clip bounds.
<TLookup> TLookup	lookup(Class<TLookup> type) Implements the ILookup interface.
protected Object	lookupContext(TemplatePortStyle style, IPort port, Class type) Delegates to the TemplatePortStyle's ContextLookup.
protected void	setPort(IPort value) Sets the currently configured port.
protected void	setStyle(TemplatePortStyle 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

TemplatePortStyleRenderer

public TemplatePortStyleRenderer()

Method Detail

arrange

protected void arrange(Node portControl)

Arranges the port control according to the location of the port and the getRenderSize().

Parameters:

portControl - The port control.

configure

protected void configure()

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

Upon invocation the Style and Port properties have been populated by the getVisualCreator(IPort, IPortStyle), getBoundsProvider(IPort, IPortStyle), getHitTestable(IPort, IPortStyle), or getMarqueeTestable(IPort, IPortStyle) methods.

createVisual

public final Node createVisual(IRenderContext context)

Creates the visual by delegating to TemplatePortStyle.createControl(IRenderContext, IPort) 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 port.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

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(IPort port,
                                         IPortStyle style)

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

Specified by:

getBoundsProvider in interface IPortStyleRenderer

Parameters:

port - The port to retrieve the bounds provider for. The value will be stored in the Port property.

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

Returns:

this

See Also:

getBounds(ICanvasContext)

getCenter

protected final PointD getCenter()

Gets the center of the port.

Returns:

The center coordinates.

getContext

public ILookup getContext(IPort port,
                          IPortStyle style)

Configures the style and port 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 IPortStyleRenderer

Parameters:

port - The port to query the context for. The value will be stored in the Port property.

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

Returns:

this

See Also:

lookup(Class)

getHitTestable

public IHitTestable getHitTestable(IPort port,
                                   IPortStyle style)

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

Specified by:

getHitTestable in interface IPortStyleRenderer

Parameters:

port - The port to query hit test with. The value will be stored in the Port property.

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

Returns:

this

See Also:

isHit(IInputModeContext, PointD)

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(IPort port,
                                           IPortStyle style)

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

Specified by:

getMarqueeTestable in interface IPortStyleRenderer

Parameters:

port - The port to query marquee intersection tests. The value will be stored in the Port property.

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

Returns:

this

See Also:

isInBox(IInputModeContext, RectD)

getNormalizedOutline

protected GeneralPath getNormalizedOutline(TemplatePortStyle style)

Gets the normalized outline by delegating to NormalizedOutline.

getPort

protected final IPort getPort()

Gets the currently configured port.

Returns:

The Port.

See Also:

setPort(IPort)

getPreferredSize

protected SizeD getPreferredSize(IRenderContext context)

Gets the preferred size for the current configuration.

Returns:

The preferred size.

getPreferredSize

public SizeD getPreferredSize(IRenderContext context,
                              IPort port,
                              TemplatePortStyle style)

Calculates the preferred size for the given port and style.

Parameters:

context - The render context which can be null.

port - The port instance.

style - The style instance to apply.

Returns:

The preferred size for the given label and style.

See Also:

getPreferredSize(IRenderContext)

getRenderSize

protected SizeD getRenderSize()

Gets the size of the rendering from the style.

Returns:

The RenderSize.

getStyle

protected final TemplatePortStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(TemplatePortStyle)

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(IPort port,
                                                 IPortStyle style)

Configures the style and port 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 IPortStyleRenderer

Parameters:

port - The port to query visibility tests. The value will be stored in the Port property.

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

Returns:

this

See Also:

isVisible(ICanvasContext, RectD)

getVisualCreator

public IVisualCreator getVisualCreator(IPort port,
                                       IPortStyle style)

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

Specified by:

getVisualCreator in interface IPortStyleRenderer

Parameters:

port - The port to retrieve the IVisualCreator for. The value will be stored in the Port property.

style - The style to associate with the port. 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)

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

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Calls configure() and test the Port using the Style for a visible intersection with the clip bounds.

This simple implementation uses getBounds(ICanvasContext) to determine the visibility. Subclasses may choose to override this behavior for improved performance but need to make sure to call configure() if they depend on a configured instance.

Specified by:

isVisible in interface IVisibilityTestable

Parameters:

context - the current canvas context

rectangle - the clip bounds

Returns:

true if the port may be painted within the clip bounds.

See Also:

getVisibilityTestable(IPort, IPortStyle)

lookup

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

Implements the ILookup interface.

This method will be used by default if getContext(IPort, IPortStyle) has been queried for a lookup implementation. Note that it cannot be assumed that configure() has already been invoked. However, normally Port 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.

lookupContext

protected Object lookupContext(TemplatePortStyle style,
                               IPort port,
                               Class type)

Delegates to the TemplatePortStyle's ContextLookup.

setPort

protected final void setPort(IPort value)

Sets the currently configured port.

Parameters:

value - The Port to set.

See Also:

getPort()

setStyle

protected final void setStyle(TemplatePortStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public final 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 port.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl