| Package | com.adobe.coreUI.controls.whiteboardClasses.ToolBarDescriptors |
| Class | public class WBShapeToolBarDescriptor |
| Property | Defined 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
WBShapeToolBarDescriptor(p_type:String)
Constructor.
| WBShapeToolBarDescriptor | ||
| Constant | Defined by | ||
|---|---|---|---|
| COMMAND : String = "command" [static]
| WBShapeToolBarDescriptor | ||
| LABEL : String = "label" [static]
| WBShapeToolBarDescriptor | ||
| TOOL : String = "tool" [static]
| WBShapeToolBarDescriptor | ||
| children | property |
public var children:ArrayThe 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.
| command | property |
public var command:StringThe command that would be dispatched by the toolBar. Used if the type is WBShapeToolBarDescriptor.COMMAND
| icon | property |
public var icon:ClassThe Icon of the toolBar component
| label | property |
public var label:StringThe text of the Label if the type is WBShapeToolBarDescriptor.LABEL
| shapeFactory | property |
public var shapeFactory:IWBShapeFactoryThe shape factory associated with the shape.
| toolTip | property |
public var toolTip:StringThe tooltip of the toolBar component
| type | property |
public var type:StringThe type of the WhiteBoard element. You use the following constants to set this property WBShapeToolBarDescriptor.LABEL or WBShapeToolBarDescriptor.TOOL or WBShapeToolBarDescriptor.COMMAND
| 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
|
| COMMAND | constant |
public static const COMMAND:String = "command"
| LABEL | constant |
public static const LABEL:String = "label"
| TOOL | constant |
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