com.yworks.yfiles.graph.styles

Class CollapsibleNodeStyleDecorator

java.lang.Object

com.yworks.yfiles.graph.styles.CollapsibleNodeStyleDecorator

All Implemented Interfaces:

INodeStyle, ICloneable, Cloneable

public class CollapsibleNodeStyleDecorator
extends Object
implements INodeStyle, Cloneable

Decorates an arbitrary node styles with an additional collapse/expand handle.

This style uses the CollapsibleNodeStyleDecoratorRenderer to adorn an existing INodeStyle with a Button that can then be used to trigger the ICommand.TOGGLE_EXPANSION_STATE.

By default, this handle is rendered as a plus ("+") sign when in collapsed state, and a minus ("-") sign when in expanded state.

See Also:

CollapsibleNodeStyleDecoratorRenderer

Constructor Summary

Constructors

Constructor and Description
CollapsibleNodeStyleDecorator() Initializes a new instance of the CollapsibleNodeStyleDecorator class.
CollapsibleNodeStyleDecorator(INodeStyle wrapped) Initializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the Wrapped property and the provided CollapsibleNodeStyleDecoratorRenderer as renderer.
CollapsibleNodeStyleDecorator(INodeStyle wrapped, CollapsibleNodeStyleDecoratorRenderer renderer) Initializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the Wrapped property and the provided CollapsibleNodeStyleDecoratorRenderer as renderer.

Method Summary

Modifier and Type	Method and Description
CollapsibleNodeStyleDecorator	clone() Creates a copy of this object and returns it.
ILabelModelParameter	getButtonPlacement() Gets an ILabelModelParameter that determines the placement of the button for toggling the expanded state.
SizeD	getButtonSize() Returns the size of the collapse button.
InsetsD	getInsets() Gets the insets to use for the INodeInsetsProvider that will be reported by the CollapsibleNodeStyleDecoratorRenderer's ILookup.
CollapsibleNodeStyleDecoratorRenderer	getRenderer() Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given node and this style instance.
INodeStyle	getWrapped() Gets the wrapped node style that will be used to perform the actual rendering of the node.
void	setButtonPlacement(ILabelModelParameter value) Sets an ILabelModelParameter that determines the placement of the button for toggling the expanded state.
void	setInsets(InsetsD value) Sets the insets to use for the INodeInsetsProvider that will be reported by the CollapsibleNodeStyleDecoratorRenderer's ILookup.
void	setWrapped(INodeStyle value) Sets the wrapped node style that will be used to perform the actual rendering of the node.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollapsibleNodeStyleDecorator

public CollapsibleNodeStyleDecorator()

Initializes a new instance of the CollapsibleNodeStyleDecorator class.

The Wrapped property will be initialized with a ShapeNodeStyle.

CollapsibleNodeStyleDecorator

public CollapsibleNodeStyleDecorator(INodeStyle wrapped)

Initializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the Wrapped property and the provided CollapsibleNodeStyleDecoratorRenderer as renderer.

Parameters:

wrapped - The decorated style.

CollapsibleNodeStyleDecorator

public CollapsibleNodeStyleDecorator(INodeStyle wrapped,
                                     CollapsibleNodeStyleDecoratorRenderer renderer)

Initializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the Wrapped property and the provided CollapsibleNodeStyleDecoratorRenderer as renderer.

Parameters:

wrapped - The decorated style.

renderer - An instance of CollapsibleNodeStyleDecoratorRenderer to render this style.

Method Detail

clone

public final CollapsibleNodeStyleDecorator clone()

Description copied from interface: ICloneable

Creates a copy of this object and returns it.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A copy of this object.

See Also:

Object.clone()

getButtonPlacement

public final ILabelModelParameter getButtonPlacement()

Gets an ILabelModelParameter that determines the placement of the button for toggling the expanded state.

The ILabelModelParameter should support labels bound to an INode because the button will be positioned as if it was an ILabel owned by the INode that uses this style.

Returns:

The ButtonPlacement.

See Also:

setButtonPlacement(ILabelModelParameter)

getButtonSize

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

getInsets

public final InsetsD getInsets()

Gets the insets to use for the INodeInsetsProvider that will be reported by the CollapsibleNodeStyleDecoratorRenderer's ILookup.

This effectively influences the way the bounds of a group node are being calculated. The default IGroupBoundsCalculator implementation will use these insets to determine the minimum size of a group node given a set of contained nodes.

Returns:

The Insets.

See Also:

setInsets(InsetsD)

getRenderer

public final CollapsibleNodeStyleDecoratorRenderer getRenderer()

Description copied from interface: INodeStyle

Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given node and this style instance.

The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:

Specified by:

getRenderer in interface INodeStyle

Returns:

The Renderer.

getWrapped

public final INodeStyle getWrapped()

Gets the wrapped node style that will be used to perform the actual rendering of the node.

Returns:

The Wrapped.

See Also:

setWrapped(INodeStyle)

setButtonPlacement

public final void setButtonPlacement(ILabelModelParameter value)

Sets an ILabelModelParameter that determines the placement of the button for toggling the expanded state.

The ILabelModelParameter should support labels bound to an INode because the button will be positioned as if it was an ILabel owned by the INode that uses this style.

Parameters:

value - The ButtonPlacement to set.

See Also:

getButtonPlacement()

setInsets

public final void setInsets(InsetsD value)

Sets the insets to use for the INodeInsetsProvider that will be reported by the CollapsibleNodeStyleDecoratorRenderer's ILookup.

This effectively influences the way the bounds of a group node are being calculated. The default IGroupBoundsCalculator implementation will use these insets to determine the minimum size of a group node given a set of contained nodes.

Parameters:

value - The Insets to set.

See Also:

getInsets()

setWrapped

public final void setWrapped(INodeStyle value)

Sets the wrapped node style that will be used to perform the actual rendering of the node.

Parameters:

value - The Wrapped to set.

See Also:

getWrapped()