TemplatePortStyleRenderer

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

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: the context to calculate the bounds for

Returns

↪Rect: the bounds or EMPTY to indicate an unbound area

Implements

IBoundsProvider

getBoundsProvider

(port: IPort, style: IPortStyle) : IBoundsProvider

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

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to retrieve the bounds provider for. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Configures the style and port parameters, does not call configure and returns this.

Remarks

As this method may be called often it will not automatically call configure, instead subclasses should ensure that in the lookup 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.

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to query the context for. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Returns

↪ILookup: this

Implements

IPortStyleRenderer

getHitTestable

(port: IPort, style: IPortStyle) : IHitTestable

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

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to query hit test with. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Returns

↪IHitTestable: this

Implements

IPortStyleRenderer

getMarqueeTestable

(port: IPort, style: IPortStyle) : IMarqueeTestable

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

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to query marquee intersection tests. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Returns

↪IMarqueeTestable: this

Implements

IPortStyleRenderer

getNormalizedOutline

(style: TemplatePortStyleBase) : GeneralPath

Gets the normalized outline by delegating to normalizedOutline.

getOffset

() : Point

Gets the offset for the visualization.

Returns

↪Point: The offset.

getRenderSize

() : Size

Gets the size of the rendering from the style.

Returns

↪Size: The renderSize.

getVisibilityTestable

(port: IPort, style: IPortStyle) : IVisibilityTestable

Configures the style and port parameters, does not call configure and returns this.

Remarks

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.

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to query visibility tests. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Returns

↪IVisibilityTestable: this

Implements

IPortStyleRenderer

getVisualCreator

(port: IPort, style: IPortStyle) : IVisualCreator

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

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port to retrieve the IVisualCreator for. The value will be stored in the port property.
style - IPortStyle: The style to associate with the port. The value will be stored in the style property.

Returns

↪IVisualCreator: this

Implements

IPortStyleRenderer

isHit

(context: IInputModeContext, location: Point) : boolean

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

Remarks

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.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the context the hit test is performed in
location - Point: the coordinates in world coordinate system

Returns

↪boolean: whether something has been hit

Implements

IHitTestable

isInBox

(context: IInputModeContext, rectangle: Rect) : boolean

Returns true if the corresponding item is considered to intersect the given rectangular box.

Remarks

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.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
rectangle - Rect: the box describing the marquee's bounds

Returns

↪boolean: true if the item is considered to be captured by the marquee

Implements

IMarqueeTestable

isInPath

(context: IInputModeContext, lassoPath: GeneralPath) : boolean

Returns true if the corresponding item is considered to intersect the given path.

Remarks

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

Implementations should respect the hitTestRadius if lasso selections should behave differently on different zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
lassoPath - GeneralPath: the path describing the lasso selection bounds

Returns

↪boolean: true if the item is considered to be captured by the lasso

Implements

ILassoTestable

isVisible

(context: ICanvasContext, rectangle: Rect) : boolean

Calls configure and test the port using the style for a visible intersection with the clip bounds.

Remarks

This implementation uses getBounds 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.

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: the current canvas context
rectangle - Rect: the clip bounds

Returns

↪boolean: true if the port may be painted within the clip bounds.

Implements

IVisibilityTestable

lookup

<Textends any>(type: Class<T>) : T

Implements the ILookup interface.

Remarks

This method will be used by default if getContext 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.

Type Parameters

T: any

Parameters

options - Object
A map of options to pass to the method.

type - Class<T>: The type to query for.

Returns

↪T: An implementation or null.

Implements

ILookup

lookupContext

(style: TemplatePortStyleBase, port: IPort, type: Class) : any

Delegates to the TemplatePortStyleBase's contextLookup.

updateVisual

(context: IRenderContext, oldVisual: Visual) : Visual

Updates the visual correspondingly.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The context for the creation.
oldVisual - Visual: The currently rendered visual.

Returns

↪Visual: The visual that is used for rendering the port.

Implements

IVisualCreator

TemplatePortStyleRenderer

Type Details

See Also

Constructors