GroupNodeStyleRenderer

The default implementation returns an SVG g element that triggers TOGGLE_EXPANSION_STATE when clicked. The default implementation returns null if the given bounds are empty.

When overriding this method, updateIconVisual should be overridden as well for better performance.

Parameters

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

context - IRenderContext: The context that describes where the visual will be used.
expanded - boolean: true if the node is currently expanded; false otherwise.
bounds - Rect: The size and location of the icon. May be empty.

Returns

↪SVGGElement: The visual representation for the node's collapse/expand icon or null if no icon should be shown.

createVisual

(context: IRenderContext) : Visual

This method is called by the framework to create a Visual that will be included into the IRenderContext.

Remarks

CanvasComponent uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Parameters

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

context - IRenderContext: The context that describes where the visual will be used.

Returns

↪Visual: The visual to include in the canvas object visual tree. This may be null.

Implements

IVisualCreator

getBounds

(context: ICanvasContext) : Rect

Returns the union of the node's layout and area that shows the style's drop shadow.

Parameters

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

context - ICanvasContext: the context to calculate the bounds for

Returns

↪Rect: Returns the union of the node's layout and area that shows the style's drop shadow.

Implements

IBoundsProvider

getBoundsProvider

(node: INode, style: INodeStyle) : IBoundsProvider

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

Parameters

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

node - INode: The node to retrieve the bounds provider for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IBoundsProvider: this

Implements

INodeStyleRenderer

getContentAreaFill

() : Fill

Gets the content area brush that is currently used by this renderer.

Remarks

This implementation retrieves the contentAreaFill from the owning style.

Returns

↪Fill: The content area brush that is currently used by this renderer.

getContentAreaInsets

() : Insets

Gets the content area insets that are currently used by this renderer.

Remarks

This implementation retrieves the contentAreaInsets from the owning style.

Returns

↪Insets: The content area insets that are currently used by this renderer.

getContext

(node: INode, style: INodeStyle) : ILookup

Configures the style and node 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.

node - INode: The node to query the context for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪ILookup: this

Implements

INodeStyleRenderer

getCornerRadius

() : number

Gets the corner radius that is currently used by this renderer.

Remarks

This implementation retrieves the cornerRadius from the owning style.

Returns

↪number: The corner radius that is currently used by this renderer.

getCssClass

() : string

Get the CSS class that is currently used by this renderer.

Remarks

This implementation retrieves the CSS class from the owning style.

Returns

↪string: The CSS class that is currently used by this renderer.

getFolderIcon

() : GroupNodeStyleIconType

Gets the folder icon type that is currently used by this renderer.

Remarks

This implementation retrieves the folderIcon type from the owning style.

Returns

↪GroupNodeStyleIconType: The folder icon type that is currently used by this renderer.

getGroupIcon

() : GroupNodeStyleIconType

Gets the group icon type that is currently used by this renderer.

Remarks

This implementation retrieves the groupIcon type from the owning style.

Returns

↪GroupNodeStyleIconType: The group icon type that is currently used by this renderer.

getHitTestable

(node: INode, style: INodeStyle) : IHitTestable

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

Parameters

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

node - INode: The node to query hit test with. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IHitTestable: this

Implements

INodeStyleRenderer

getIconBackgroundFill

() : Fill

Gets the icon background brush that is currently used by this renderer.

Remarks

This implementation retrieves the iconBackgroundFill from the owning style.

Returns

↪Fill: The icon background brush that is currently used by this renderer.

getIconBackgroundShape

() : GroupNodeStyleIconBackgroundShape

Gets the icon background shape that is currently used by this renderer.

Remarks

This implementation retrieves the iconBackgroundShape from the owning style.

Returns

↪GroupNodeStyleIconBackgroundShape: The icon background shape that is currently used by this renderer.

getIconForegroundFill

() : Fill

Gets the icon foreground brush that is currently used by this renderer.

Remarks

This implementation retrieves the iconForegroundFill from the owning style.

Returns

↪Fill: The icon foreground brush that is currently used by this renderer.

getIconOffset

() : number

Gets the icon offset that is currently used by this renderer.

Remarks

This implementation retrieves the iconOffset from the owning style.

Returns

↪number: The icon offset that is currently used by this renderer.

getIconPosition

() : GroupNodeStyleIconPosition

Gets the icon position that is currently used by this renderer.

Remarks

This implementation retrieves the iconPosition from the owning style.

Returns

↪GroupNodeStyleIconPosition: The icon position that is currently used by this renderer.

getIconSize

() : number

Gets the icon size that is currently used by this renderer.

Remarks

This implementation retrieves the iconSize from the owning style.

Returns

↪number: The icon size that is currently used by this renderer.

getIntersection

(inner: Point, outer: Point) : Point

Returns the intersection for the given line with this shape's geometry.

Parameters

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

inner - Point: The first point of the line that is inside the shape.
outer - Point: The second point of the line that is outside the shape.

Returns

↪Point: The coordinates of the intersection point, if an intersection was found.

Implements

IShapeGeometry

getMarqueeTestable

(node: INode, style: INodeStyle) : IMarqueeTestable

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

Parameters

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

node - INode: The node to query marquee intersection tests. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IMarqueeTestable: this

Implements

INodeStyleRenderer

getMinimumContentAreaSize

() : Size

Gets the minimum content area size that is currently used by this renderer.

Remarks

This implementation retrieves the minimumContentAreaSize from the owning style.

Returns

↪Size: The minimum content area size that is currently used by this renderer.

getOutline

() : GeneralPath

Returns the outline of the shape or null.

Remarks

If null is returned callers may assume the canonical outline as result. For nodes this is the node's layout.

Returns

↪GeneralPath: The outline or null if no outline can be provided.

Implements

IShapeGeometry

getShapeGeometry

(node: INode, style: INodeStyle) : IShapeGeometry

Configures the style and node properties, calls configure and returns this.

Parameters

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

node - INode: The node to retrieve the shape geometry for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Gets the pen that is currently used by this renderer.

Remarks

This implementation retrieves the stroke from the owning style.

Returns

↪Stroke: The pen that is currently used by this renderer.

getTabBackgroundFill

() : Fill

Gets the tab background brush that is currently used by this renderer.

Remarks

This implementation retrieves the tabBackgroundFill from the owning style.

Returns

↪Fill: The tab background brush that is currently used by this renderer.

getTabFill

() : Fill

Gets the tab brush that is currently used by this renderer.

Remarks

This implementation retrieves the tabFill from the owning style.

Returns

↪Fill: The tab brush that is currently used by this renderer.

getTabHeight

() : number

Gets the tab height that is currently used by this renderer.

Remarks

This implementation retrieves the tabHeight from the owning style.

Returns

↪number: The tab height that is currently used by this renderer.

getTabInset

() : number

Gets the tab inset that is currently used by this renderer.

Remarks

This implementation retrieves the tabInset from the owning style.

Returns

↪number: The tab inset that is currently used by this renderer.

getTabPosition

() : GroupNodeStyleTabPosition

Gets the tab position that is currently used by this renderer.

Remarks

This implementation retrieves the tabPosition from the owning style.

Returns

↪GroupNodeStyleTabPosition: The tab position that is currently used by this renderer.

getTabSizePolicy

() : GroupNodeStyleTabSizePolicy

Gets the tab size policy that is currently used by this renderer.

Remarks

This implementation retrieves the tabSizePolicy from the owning style.

Returns

↪GroupNodeStyleTabSizePolicy: The tab size policy that is currently used by this renderer.

getTabSlope

() : number

Gets the tab slope that is currently used by this renderer.

Remarks

This implementation retrieves the tabSlope from the owning style.

Returns

↪number: The tab slope that is currently used by this renderer.

getTabWidth

() : number

Gets the tab width that is currently used by this renderer.

Remarks

This implementation retrieves the tabWidth from the owning style.

Returns

↪number: The tab width that is currently used by this renderer.

getVisibilityTestable

(node: INode, style: INodeStyle) : IVisibilityTestable

Configures the style and node parameters, calls 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.

node - INode: The node to query visibility tests. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IVisibilityTestable: this

Implements

INodeStyleRenderer

getVisualCreator

(node: INode, style: INodeStyle) : IVisualCreator

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

Parameters

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

node - INode: The node to retrieve the IVisualCreator for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IVisualCreator: this

Implements

INodeStyleRenderer

isDrawShadow

() : boolean

Returns true if this renderer is currently drawing a drop shadow; false otherwise.

Remarks

This implementation queries the drawShadow property from the owning style.

Returns

↪boolean: true if this renderer is currently drawing a drop shadow; false otherwise.

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

isHitTransparentContentArea

() : boolean

Returns true if this renderer is currently considering the content area to be hit transparent; false otherwise.

Remarks

This implementation queries the hitTransparentContentArea property from the owning style.

Returns

↪boolean: true if this renderer is currently considering the content area to be hit transparent; false otherwise.

isInBox

(context: IInputModeContext, rectangle: Rect) : boolean

Tests the node using the current style for an intersection with the given box.

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 node is considered to be captured by the marquee

Implements

IMarqueeTestable

isInPath

(context: IInputModeContext, lassoPath: GeneralPath) : boolean

Tests the node using the current style for an intersection with the the given path.

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

isInside

(location: Point) : boolean

Checks whether the given coordinate is deemed to lie within the shape's geometric bounds.

Parameters

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

location - Point: The point to test.

Returns

↪boolean: True if the point lies within the shape.

Implements

IShapeGeometry

isRenderTransparentContentArea

() : boolean

Returns true if this renderer is currently clipping the visualization to allow for a transparent content area; false otherwise.

Remarks

This implementation queries the renderTransparentContentArea property from the owning style.

Returns

↪boolean: true if this renderer is currently allowing the content area to be rendered transparently; false otherwise.

isShowFolderContentArea

() : boolean

Returns true if this renderer is currently showing the content area for collapsed nodes; false otherwise.

Remarks

This implementation queries the showFolderContentArea property from the owning style.

Returns

↪boolean: true if this renderer is currently showing the content area for collapsed nodes; false otherwise.

isVisible

(context: ICanvasContext, rectangle: Rect) : boolean

Determines visibility by checking for an intersection with the layout.

Parameters

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

context - ICanvasContext: The context.
rectangle - Rect: The current clip

Returns

↪boolean: Whether the layout is visible in the clip.

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 node 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

updateIconVisual

(context: IRenderContext, expanded: boolean, bounds: Rect, oldVisual: SVGGElement) : SVGGElement

Updates the visual representation for the node's collapse/expand icon previously created by createIconVisual.

Parameters

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

context - IRenderContext: The context that describes where the visual will be used.
expanded - boolean: true if the node is currently expanded; false otherwise.
bounds - Rect: The size and location of the icon. May be empty.
oldVisual - SVGGElement: The visual instance that has been returned the last time createIconVisual has been called.

Returns

↪SVGGElement: The visual representation for the node's collapse/expand icon or null if no icon should be shown.

updateVisual

(context: IRenderContext, oldVisual: Visual) : Visual

This method updates or replaces a previously created Visual for inclusion in the IRenderContext.

Remarks

The CanvasComponent 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 createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.

Parameters

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

context - IRenderContext: The context that describes where the visual will be used in.
oldVisual - Visual: The visual instance to be updated.

Returns

↪Visual: oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

Implements

IVisualCreator

GroupNodeStyleRenderer

Type Details

Constructors