Packagecom.yworks.graph.drawing
Interfacepublic interface ICollapsibleNodeStyleDecorator extends INodeStyle, IVisualStyle, ICloneable
Implementors CollapsibleNodeStyleDecorator

Interface that is used by CollapsibleNodeStyleDecoratorRenderer to describe the way a node should be styled to support a collapse/expand button.

CollapsibleNodeStyleDecorator is a convenient default implementation of this interface. This style can be used to decorate any existing INodeStyle to support the IFoldedGraph's expand and collapse operations that are provided by the FoldingManager visually and interactively.

See also

CollapsibleNodeStyleDecorator
com.yworks.graph.model.FoldingManager
com.yworks.graph.model.IFoldedGraph


Public Properties
 PropertyDefined By
  buttonLocationParameter : ILabelModelParameter
[read-only] An ILabelModelParameter that determines the placement of the button for toggling the expanded state.
ICollapsibleNodeStyleDecorator
  collapsedIcon : IIcon
[read-only] Yields the icon to use for displaying the button on a collapsed group node.
ICollapsibleNodeStyleDecorator
  expandedIcon : IIcon
[read-only] Yields the icon to use for displaying the button on an expanded group node.
ICollapsibleNodeStyleDecorator
  insets : Rectangle
[read-only] Yields the insets to use for the IInsetsProvider that will be reported by the CollapsibleNodeStyleDecoratorRenderer's ILookup.
ICollapsibleNodeStyleDecorator
 InheritedstyleRenderer : IStyleRenderer
[read-only] Gets the renderer implementation that has been supplied to this instance upon creation.
IVisualStyle
  wrapped : INodeStyle
[read-only] The wrapped node style that will be used to perform the actual rendering of the node.
ICollapsibleNodeStyleDecorator
Public Methods
 MethodDefined By
 Inherited
clone():Object
Creates a clone of this instance.
ICloneable
 Inherited
install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array
Prepares the rendering of an IModelItem in a CanvasComponent by adding ICanvasObject's to the provided canvas.
IVisualStyle
Property Detail
buttonLocationParameterproperty
buttonLocationParameter:ILabelModelParameter  [read-only]

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.


Implementation
    public function get buttonLocationParameter():ILabelModelParameter
collapsedIconproperty 
collapsedIcon:IIcon  [read-only]

Yields the icon to use for displaying the button on a collapsed group node.


Implementation
    public function get collapsedIcon():IIcon
expandedIconproperty 
expandedIcon:IIcon  [read-only]

Yields the icon to use for displaying the button on an expanded group node.


Implementation
    public function get expandedIcon():IIcon
insetsproperty 
insets:Rectangle  [read-only]

Yields the insets to use for the IInsetsProvider 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.


Implementation
    public function get insets():Rectangle
wrappedproperty 
wrapped:INodeStyle  [read-only]

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


Implementation
    public function get wrapped():INodeStyle