Packagecom.adobe.coreUI.controls.whiteboardClasses.ToolBarDescriptors
Classpublic class WBShapeToolBarDescriptor



Public Properties
 PropertyDefined by
  children : Array
The children of a toolBar component.
WBShapeToolBarDescriptor
  command : String
The command that would be dispatched by the toolBar.
WBShapeToolBarDescriptor
  icon : Class
The Icon of the toolBar component
WBShapeToolBarDescriptor
  label : String
The text of the Label if the type is WBShapeToolBarDescriptor.LABEL
WBShapeToolBarDescriptor
  shapeFactory : IWBShapeFactory
The shape factory associated with the shape.
WBShapeToolBarDescriptor
  toolTip : String
The tooltip of the toolBar component
WBShapeToolBarDescriptor
  type : String
The type of the WhiteBoard element.
WBShapeToolBarDescriptor
Public Methods
 MethodDefined by
  
WBShapeToolBarDescriptor(p_type:String)
Constructor.
WBShapeToolBarDescriptor
Public Constants
 ConstantDefined by
  COMMAND : String = "command"
[static]
WBShapeToolBarDescriptor
  LABEL : String = "label"
[static]
WBShapeToolBarDescriptor
  TOOL : String = "tool"
[static]
WBShapeToolBarDescriptor
Property detail
childrenproperty
public var children:Array

The children of a toolBar component. This would enable a toolBar component to have a sub ToolBar. Example

   var shapeSubToolBar:WBToolBarDescriptor = new WBToolBarDescriptor(false); //SubTool Bar
   
   var shapesLabelShape:WBShapeToolBarDescriptor = new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.LABEL); // Label Shape
   shapesLabelShape.label = _lm.getString("Shapes");
   shapeSubToolBar.addShapeToolBar(shapesLabelShape);
   
   var undoCommand:WBShapeToolBarDescriptor  =  new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.COMMAND); //Command ToolBar component
   undoCommand.toolTip="Undo";
   undoCommand.icon=ICON_UNDO;
   undoCommand.command="undo";
   shapeSubToolBar.addShapeToolBar(undoCommand);
               
   var rectangleToolShape:WBShapeToolBarDescriptor = new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.TOOL);
   rectangleToolShape.toolTip = "Rectangle Tool";
   rectangleToolShape.shapeFactory = simpleShapeFactory; //Rectangle Shape Factory
   rectangleToolShape.icon = ICON_RECTANLGE;
   shapeSubToolBar.addShapeToolBar(rectangleToolShape);
               
   var shapesToolShape:WBShapeToolBarDescriptor  =  new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.TOOL);
   shapesToolShape.toolTip = "Shapes";
   shapesToolShape.icon = ICON_SHAPES;
   shapesToolShape.children = shapeSubToolBar.children; // Adding the children of the shapeSubToolBar to the ToolBar Component
   addShapeToolBar(shapesToolShape); // This toolBar component would have the sub Tool bar when clicked.
   

commandproperty 
public var command:String

The command that would be dispatched by the toolBar. Used if the type is WBShapeToolBarDescriptor.COMMAND

iconproperty 
public var icon:Class

The Icon of the toolBar component

labelproperty 
public var label:String

The text of the Label if the type is WBShapeToolBarDescriptor.LABEL

shapeFactoryproperty 
public var shapeFactory:IWBShapeFactory

The shape factory associated with the shape.

toolTipproperty 
public var toolTip:String

The tooltip of the toolBar component

typeproperty 
public var type:String

The type of the WhiteBoard element. You use the following constants to set this property WBShapeToolBarDescriptor.LABEL or WBShapeToolBarDescriptor.TOOL or WBShapeToolBarDescriptor.COMMAND

Constructor detail
WBShapeToolBarDescriptor()constructor
public function WBShapeToolBarDescriptor(p_type:String)

Constructor. Example

     var triangleShape:WBShapeToolBarDescriptor = new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.TOOL); //Shape is of type tool
     triangleShape.toolTip ="Triangle";
     triangleShape.shapeFactory = new WBCustomShapeFactory(WBTriangleShape, CURSOR_PEN, new WBTrianglePropertiesToolBar());
     triangleShape.icon = ICON_TRIANGLE;
     toolBar.addCustomShapeToToolBar(triangleShape);
   

Parameters
p_type:String — Type of the toolBar component. Possible values would be WBShapeToolBarDescriptor.LABEL or WBShapeToolBarDescriptor.TOOL or WBShapeToolBarDescriptor.COMMAND
Constant detail
COMMANDconstant
public static const COMMAND:String = "command"
LABELconstant 
public static const LABEL:String = "label"
TOOLconstant 
public static const TOOL:String = "tool"




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/coreUI/controls/whiteboardClasses/ToolBarDescriptors/WBShapeToolBarDescriptor.html