Packagecom.yworks.canvas.drawing
Classpublic class RectangularHighlightPaintable
InheritanceRectangularHighlightPaintable Inheritance Object
Implements ISelectionPaintable, IHighlightPaintableInstaller

A simple ISelectionPaintable and IHighlightPaintableInstaller implementation that draws rectangular marks at the bounds of the selected or highlighted item.



Public Properties
 PropertyDefined By
  fill : IFill
Gets or sets the fill to use for filling the rectangle.
RectangularHighlightPaintable
  highlightStroke : IStroke
Gets or sets the stroke to use for drawing the highlight.
RectangularHighlightPaintable
  stroke : IStroke
Gets or sets the stroke to use for drawing the border.
RectangularHighlightPaintable
Public Methods
 MethodDefined By
  
Creates a highlight paintable that paints the bounds.
RectangularHighlightPaintable
  
installHighlightPaintables(context:IInputModeContext, highlightGroup:ICanvasObjectGroup, item:Object):Array
Creates and installs one or more canvas objects into the canvas that indicate a selection decoration for an item.
RectangularHighlightPaintable
  
installSelectionPaintables(userObject:Object, canvas:CanvasComponent, selectionGroup:ICanvasObjectGroup):Array
Implements the interface and installs a rectangle into the canvas control.
RectangularHighlightPaintable
Protected Methods
 MethodDefined By
  
getRectangle(userObject:Object):IRectangle
Factory method that retrieves the bounds for a given user object.
RectangularHighlightPaintable
Property Detail
fillproperty
fill:IFill

Gets or sets the fill to use for filling the rectangle.


Implementation
    public function get fill():IFill
    public function set fill(value:IFill):void
highlightStrokeproperty 
highlightStroke:IStroke

Gets or sets the stroke to use for drawing the highlight.


Implementation
    public function get highlightStroke():IStroke
    public function set highlightStroke(value:IStroke):void
strokeproperty 
stroke:IStroke

Gets or sets the stroke to use for drawing the border.


Implementation
    public function get stroke():IStroke
    public function set stroke(value:IStroke):void
Constructor Detail
RectangularHighlightPaintable()Constructor
public function RectangularHighlightPaintable(bounds:IRectangle)

Creates a highlight paintable that paints the bounds.

Parameters
bounds:IRectangle
Method Detail
getRectangle()method
protected function getRectangle(userObject:Object):IRectangle

Factory method that retrieves the bounds for a given user object.

This implementation simply returns the value provided to the constructor.

Parameters

userObject:Object

Returns
IRectangle
installHighlightPaintables()method 
public function installHighlightPaintables(context:IInputModeContext, highlightGroup:ICanvasObjectGroup, item:Object):Array

Creates and installs one or more canvas objects into the canvas that indicate a selection decoration for an item.

Parameters

context:IInputModeContext — The context to add the IDisplayObjectCreator for the highlighting.
 
highlightGroup:ICanvasObjectGroup — The canvas object group to add the items to.
 
item:Object — The item to create a highlight for.

Returns
Array — An array of canvas objects this instance has installed into the CanvasComponent.
installSelectionPaintables()method 
public function installSelectionPaintables(userObject:Object, canvas:CanvasComponent, selectionGroup:ICanvasObjectGroup):Array

Implements the interface and installs a rectangle into the canvas control.

This method queries getRectangle() for a suitable rectangle.

Parameters

userObject:Object
 
canvas:CanvasComponent
 
selectionGroup:ICanvasObjectGroup

Returns
Array