Packagecom.yworks.canvas.drawing
Classpublic class RectangularFocusPaintable
InheritanceRectangularFocusPaintable Inheritance Object
Implements IFocusPaintableInstaller

An installer for an IDisplayObjectCreator that paints an rectangle as focus indicator in the created DisplayObject.



Public Properties
 PropertyDefined By
  fill : IFill
The brush to use for filling the rectangle in the view coordinate system.
RectangularFocusPaintable
  growth : Number
RectangularFocusPaintable
  stroke : IStroke
The pen to use for drawing the rectangle in the view coordinate system.
RectangularFocusPaintable
Public Methods
 MethodDefined By
  
RectangularFocusPaintable(bounds:IRectangle, stroke:IStroke = null, growth:Number = 0)
Initializes a new instance of the RectangleFocusPaintable class that uses the provided bounds for painting.
RectangularFocusPaintable
  
installFocusPaintables(context:IInputModeContext, focusGroup:ICanvasObjectGroup, item:Object):Array
Creates and installs one or more canvas objects into the canvas that indicate the focus decoration for an item.
RectangularFocusPaintable
Property Detail
fillproperty
fill:IFill

The brush to use for filling the rectangle in the view coordinate system.


Implementation
    public function get fill():IFill
    public function set fill(value:IFill):void
growthproperty 
growth:Number


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

The pen to use for drawing the rectangle in the view coordinate system.


Implementation
    public function get stroke():IStroke
    public function set stroke(value:IStroke):void
Constructor Detail
RectangularFocusPaintable()Constructor
public function RectangularFocusPaintable(bounds:IRectangle, stroke:IStroke = null, growth:Number = 0)

Initializes a new instance of the RectangleFocusPaintable class that uses the provided bounds for painting.

Parameters
bounds:IRectangle — The bounds to query for the painting.
 
stroke:IStroke (default = null) — The stroke to use. If none is provided a dashed light gray stroke is used.
 
growth:Number (default = 0) — If a value > 0 is set, the focus rectangle is larger than the node's bounds. If the value is zero (the default), the focus rectangle will be painted over the node's bounds, overlapping the default selection paintable.
Method Detail
installFocusPaintables()method
public function installFocusPaintables(context:IInputModeContext, focusGroup:ICanvasObjectGroup, item:Object):Array

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

Parameters

context:IInputModeContext — The context to add the IDisplayObjectCreator for the focus indicator.
 
focusGroup:ICanvasObjectGroup — The canvas object group to add the items to.
 
item:Object — The item to install the indicator for.

Returns
Array — An array of canvas objects this instance has installed into the CanvasComponent.