com.yworks.yfiles.graph.styles

Class CollapsibleNodeStyleDecoratorRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.CollapsibleNodeStyleDecoratorRenderer

All Implemented Interfaces:

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

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

INodeStyleRenderer implementation that can be used in conjunction with CollapsibleNodeStyleDecorator 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
CollapsibleNodeStyleDecoratorRenderer() Initializes a new instance of the CollapsibleNodeStyleDecoratorRenderer class.

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.
protected Node	createButton(IRenderContext context) Factory method that creates the toggle button instance.
protected ISelectionIndicatorInstaller	createSelectionInstaller() Callback that provides a customized ISelectionIndicatorInstaller.
Node	createVisual(IRenderContext context) Creates the visual for the given context.
RectD	getBounds(ICanvasContext context) Delegates to the getWrappedStyle() and takes the button into account.
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
protected ILabelModelParameter	getButtonPlacement() Yields the ButtonPlacement for the current Style.
protected SizeD	getButtonSize() Returns the size of the collapse button.
ILookup	getContext(INode node, INodeStyle style) Configures the style and node parameters, does not call configure() and returns this.
IHitTestable	getHitTestable(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
PointD	getIntersection(PointD inner, PointD outer) Delegates to the getWrappedStyle().
IRectangle	getLayout() Returns the Layout of the node this renderer is currently configured for.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
protected INode	getNode() Gets the currently configured node.
GeneralPath	getOutline() Delegates to the getWrappedStyle().
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Configures the Style and Node properties, calls configure() and returns this.
protected CollapsibleNodeStyleDecorator	getStyle() Gets the currently configured style.
IVisibilityTestable	getVisibilityTestable(INode node, INodeStyle style) Configures the style and node parameters, does not call configure() and returns this.
IVisualCreator	getVisualCreator(INode node, INodeStyle style) Configures the style and node parameters, calls configure() and returns this.
protected INodeStyle	getWrappedStyle() Yields the Wrapped property for the current Style.
protected boolean	isExpanded(IRenderContext context, INode node) Returns the folding state of the group node.
boolean	isHit(IInputModeContext context, PointD location) Delegates to the getWrappedStyle() and checks the button.
boolean	isInBox(IInputModeContext context, RectD rectangle) Delegates to the getWrappedStyle().
boolean	isInside(PointD location) Delegates to the getWrappedStyle().
boolean	isVisible(ICanvasContext context, RectD rectangle) Delegates to the getWrappedStyle().
<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(CollapsibleNodeStyleDecorator value) Sets the currently configured style.
protected void	updateButton(IRenderContext context, Node button, boolean expanded) Updates the toggle button depending on the folding state of the group node.
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

CollapsibleNodeStyleDecoratorRenderer

public CollapsibleNodeStyleDecoratorRenderer()

Initializes a new instance of the CollapsibleNodeStyleDecoratorRenderer class.

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 properies 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.

createButton

protected Node createButton(IRenderContext context)

Factory method that creates the toggle button instance.

The button state is automatically synchronized with the folding state of the group node. In other words, it is unchecked if the group node is expanded and vice versa.

createSelectionInstaller

protected ISelectionIndicatorInstaller createSelectionInstaller()

Callback that provides a customized ISelectionIndicatorInstaller.

Returns:

This implementation yields a RectangleIndicatorInstaller that uses RectangleIndicatorInstaller.SELECTION_TEMPLATE_KEY.

createVisual

public Node createVisual(IRenderContext context)

Creates the visual for the given context.

This method uses createButton(IRenderContext) to create the togglebutton instance. It will then use the getButtonPlacement() to determine the placement of the button and use the getWrappedStyle() to create the visual for the actual node.

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)

getBounds

public RectD getBounds(ICanvasContext context)

Delegates to the getWrappedStyle() and takes the button into account.

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)

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

Specified by:

getBoundsProvider in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the bounds provider for. The value will be stored in the Node property.

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

Returns:

this

See Also:

getBounds(ICanvasContext)

getButtonPlacement

protected ILabelModelParameter getButtonPlacement()

Yields the ButtonPlacement for the current Style.

getButtonSize

protected SizeD getButtonSize()

Returns the size of the collapse button. This method needs to be overwritten to alter the buttons size.

Returns:

the size of the collapse button.

getContext

public ILookup getContext(INode node,
                          INodeStyle style)

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

Parameters:

node - The node to query the context for. The value will be stored in the Node property.

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

Returns:

this

See Also:

lookup(Class)

getHitTestable

public IHitTestable getHitTestable(INode node,
                                   INodeStyle style)

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

Specified by:

getHitTestable in interface INodeStyleRenderer

Parameters:

node - The node to query hit test with. The value will be stored in the Node property.

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

Returns:

this

See Also:

isHit(IInputModeContext, PointD)

getIntersection

public PointD getIntersection(PointD inner,
                              PointD outer)

Delegates to the getWrappedStyle().

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.

getLayout

public final IRectangle getLayout()

Returns the Layout of the node this renderer is currently configured for.

Returns Node.Layout.

Returns:

The Layout.

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(INode node,
                                           INodeStyle style)

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

Specified by:

getMarqueeTestable in interface INodeStyleRenderer

Parameters:

node - The node to query marquee intersection tests. The value will be stored in the Node property.

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

Returns:

this

See Also:

isInBox(IInputModeContext, RectD)

getNode

protected final INode getNode()

Gets the currently configured node.

Returns:

The Node.

See Also:

setNode(INode)

getOutline

public GeneralPath getOutline()

Delegates to the getWrappedStyle().

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)

Configures the Style and Node properties, calls configure() and returns this.

Specified by:

getShapeGeometry in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the shape geometry for. The value will be stored in the Node property.

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

Returns:

this

See Also:

isInside(PointD), getIntersection(PointD, PointD)

getStyle

protected final CollapsibleNodeStyleDecorator getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(CollapsibleNodeStyleDecorator)

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(INode node,
                                                 INodeStyle style)

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

Parameters:

node - The node to query visibility tests. The value will be stored in the Node property.

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

Returns:

this

See Also:

isVisible(ICanvasContext, RectD)

getVisualCreator

public IVisualCreator getVisualCreator(INode node,
                                       INodeStyle style)

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

Specified by:

getVisualCreator in interface INodeStyleRenderer

Parameters:

node - The node to retrieve the IVisualCreator for. The value will be stored in the Node property.

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

Returns:

this

See Also:

createVisual(IRenderContext), updateVisual(IRenderContext, Node)

getWrappedStyle

protected INodeStyle getWrappedStyle()

Yields the Wrapped property for the current Style.

isExpanded

protected boolean isExpanded(IRenderContext context,
                             INode node)

Returns the folding state of the group node.

isHit

public boolean isHit(IInputModeContext context,
                     PointD location)

Delegates to the getWrappedStyle() and checks the button.

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)

Delegates to the getWrappedStyle().

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)

Delegates to the getWrappedStyle().

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)

Delegates to the getWrappedStyle().

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(CollapsibleNodeStyleDecorator value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateButton

protected void updateButton(IRenderContext context,
                            Node button,
                            boolean expanded)

Updates the toggle button depending on the folding state of the group node.

The default implementation assumes a Labeled button instance that was configured by createButton(IRenderContext).

Parameters:

expanded - true if the group node is expanded; false if it is collapsed.

See Also:

IFoldingView.isExpanded(INode)

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