---

Classes

• _global_
• Arc
• Builder
• BuilderProperty
• CanvasImage
• CanvasProps
• CanvasResizeCommand
• Command
• ConnectCommand
• ConnectionPoint
• Connector
• ConnectorHandleCommand
• ConnectorManager
• CreateCommand
• CubicCurve
• DashedArc
• DeleteCommand
• Ellipse
• Figure
• Glue
• Group
• GroupCommand
• Handle
• HandleManager
• History
• Line
• Log
• Matrix
• MatrixCommand
• Minimap
• Path
• Point
• Polygon
• Polyline
• PropertyCommand
• QuadCurve
• Stack
• Style
• Text
• Util
• ZOrderCommand

---

Built-In Namespace _global_

Field Summary

Field Attributes	Field Name and Description
	canvasProps Holds a wrapper around canvas object
	CNTRL_PRESSED A variable that tells us if CTRL is pressed
	connector Current connector.
	connectorType Connector type
	createFigureFunction the distance by which the connectors will escape Figure's bounds
	currentMoveUndo Usually an instance of a Command (see /lib/commands/*.js)
	currentSetId Keeps current figure set id
	defaultLineWidth Default line width
	doUndo Activate or deactivate the undo feature*
	dragging Set on true while we drag
	gridVisible Toggle grid visible or not
	IDENTITY The identity matrix
	IE A variable that will tell us if we are in IE
	KEY Just keeps all the codes we need for the application in one place and with name tag
	lastClick Keeps last coodinates while dragging
	lastMousePosition Stores last mouse position.
	lastMove Remembers last move.
	LOG_LEVEL_DEBUG show even the debug messages
	LOG_LEVEL_ERROR show only errors
	LOG_LEVEL_INFO show all up to (and including) info Setting the log level at info level will slow your browser a lot.
	LOG_LEVEL_NONE no debug at all
	mousePressed keeps track if the MLB is pressed
	R90 A predefined matrix of a 90 degree clockwise rotation
	R90A A predefined matrix of a 90 degree anti-clockwise rotation
	selectedConnectionPointId Currently selected ConnectionPoint (if -1 none is selected)
	selectedConnectorId Current selecte connector (-1 if none selected)
	selectedFigureId Current selected figure id ( -1 if none selected)
	selectedGroupId Current selected group (-1 if none selected)
	selectionArea The (current) selection area
	SHIFT_PRESSED A variable that tells us if SHIFT is pressed
	snapMonitor It will accumulate the changes on either X or Y coordinates for snap effect.
	snapTo Makes figure snap to grid
	state Keeps current state
	STATE_CONNECTOR_MOVE_POINT move a connection point of a connector
	STATE_CONNECTOR_PICK_FIRST we are selecting the start of a connector
	STATE_CONNECTOR_PICK_SECOND we are selecting the end of a connector
	STATE_CONNECTOR_SELECTED we selected a connector (for further editing for example)
	STATE_FIGURE_CREATE we have figure to be created*
	STATE_FIGURE_SELECTED we selected a figure (for further editing for example)
	STATE_GROUP_SELECTED we have a group selected (either temporary or permanent)
	STATE_NONE the default application state
	STATE_SELECTING_MULTIPLE we are dragging the mouse over a group of figures.
	testNS Thinking to use name spaces more TODO: avoid colision

Method Summary

Method Attributes	Method Name and Description
	action(action) Dispatch actions.
	connectorPickFirst(x, y, ev) Pick the first connector we can get at (x,y) position
	connectorPickSecond(x, y, ev) Pick the second connector we can get at (x,y) position
	createFigure(fFunction) Setup the creation function (that -later, upon calling - will create the actual {Figure} Note: It will also set the current state to STATE_FIGURE_CREATE
	draw() Draws all the stuff on the canvas
	figure_CanvasImage(x, y)
	figure_Circle(x, y)
	figure_Diamond(x, y)
	figure_Ellipse(x, y)
	figure_Hexagon(x, y)
	figure_Octogon(x, y)
	figure_Page(x, y)
	figure_PageLowerCornerFolded(x, y)
	figure_PageUpperCornerFolded(x, y)
	figure_Parallelogram(x, y)
	figure_Pentagon(x, y)
	figure_Polyline(x, y)
	figure_Rectangle(x, y)
	figure_RightTriangle(x, y)
	figure_RoundedRectangle(x, y)
	figure_SemiCircleDown(x, y)
	figure_SemiCircleUp(x, y)
	figure_Square(x, y)
	figure_Stop(x, y) ".
	figure_Text(x, y)
	figure_Triangle(x, y)
	generateMoveMatrix(fig, x, y) Creates a moving matrix taking into consideration the snapTo option The strange stuff is that Dia (http://projects.gnome.org/dia/) is using a top/left align but OpenOffice's Draw is using something similar to Diagramo
	getBodyXY(ev) Computes the (x,y) coordinates of an event in page
	getCanvas() Return current canvas.
	getCanvasBounds() Computes the bounds of the canvas
	getCanvasXY(ev) Extracts the X and Y from an event (for canvas)
	getContext() Return the 2D context of current canvas
	isBrowserReady() This functions detects if a browser supports tag and if it does it tests to see if beasic drawring features are supported
	isNumeric(input) Check if a value is numeric
	modal() Displays a modal window with information about the browser HTML5 support Note: requires jquery.simplemodal-1.3.5.min.js to be loaded
	onClick(ev) Click is disabled because we need to handle mouse down and mouse up.
	onKeyDown(ev) Receives the key code of keyboard but not the ASCII Treats the key pressed event
	onKeyPress(ev) Receives the ASCII character code but not the keyboard code
	onKeyUp(ev) Treats the key up event
	onMouseDown(ev) Treats the mouse down event
	onMouseMove(ev) Treats the mouse move event
	onMouseUp(ev) Treats the mouse up event
	reset() Cleans up the canvas
	setFigureSet(id) Reveals the figure set named by 'name' and hide previously displayed set
	setUpEditPanel(shape) Setup the editor panel for a special shape.
	showGrid() Makes grid visible or invisible, depedinding of previous value
	signum(x) Returns the sign of a number
	snapToGrid() Activate snapToGrip option
	stopselection(ev) Supposelly stop any selection from happening
	touchCancel(event) Triggered when touch is canceled (iPad/iPhone).
	touchEnd(event) Triggered when touch ends (iPad/iPhone).
	touchMove(event) Triggered while touching and moving is in progress (iPad/iPhone).
	touchStart(event) Triggered when an touch is initiated (iPad/iPhone).
	updateFigure(figureId, property, newValue) Update an object (Figure or Connector)

---

---

---

---

---

---

---

---

---

---

---

---

---

See:

Char codes http://www.cambiaresearch.com/c4/702b8cd1-e5b0-42e6-83ac-25f0306e3e25/Javascript-Char-Codes-Key-Codes.aspx

Event properties http://www.quirksmode.org/js/events_properties.html

---

---

---

---

---

---

---

---

---

See:

http://en.wikipedia.org/wiki/Rotation_matrix

---

See:

http://en.wikipedia.org/wiki/Rotation_matrix

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

See:

http://michaux.ca/articles/javascript-namespacing

http://www.dustindiaz.com/namespace-your-javascript/

Parameters:

{String} action

- the action name

---

Parameters:

{Number} x

- the x position

{Number} y

- the y position

{Event} ev

- the event triggered

---

Parameters:

{Number} x

- the x position

{Number} y

- the y position

{Event} ev

- the event triggered

---

Parameters:

{Function} fFunction

- the function used to create the figure

---

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

x

y

---

Parameters:

{Object} fig

- could be a figure, or a Connector

{Number} x

- mouse position

{Number} y

- mouse position

Returns:

{Matrix} - translation matrix

---

Parameters:

{Event} ev

- the event

---

---

---

Parameters:

{Event} ev

- the event

---

---

Returns:

{Number} 0 - means no support at all, 1-means simulated support IE 2-means full support

---

Parameters:

{String} input

- a numeric value

See:

http://stackoverflow.com/questions/18082/validate-numbers-in-javascript-isnumeric

---

---

Parameters:

ev

---

Parameters:

{Event} ev

- the event generated when key is down

See:

http://www.quirksmode.org/js/keys.html

---

Parameters:

{Event} ev

- the event generated when kay is pressed

See:

http://www.quirksmode.org/js/keys.html

---

Parameters:

{Event} ev

- the event generated when key is up

---

Parameters:

{Event} ev

- the event generated when key is up

---

Parameters:

{Event} ev

- the event generated when key is up

---

Parameters:

{Event} ev

- the event generated when key is up

---

---

Parameters:

{String} id

- the (div) id value of the set

---

Parameters:

shape

- can be either Connector or Figure. If null is provided the editor panel will be disabled

---

---

Parameters:

{Number} x

- the number

Returns:

{Number}

See:

http://en.wikipedia.org/wiki/Sign_function

---

---

Parameters:

ev

---

Parameters:

{Event} event

- the event triggered

---

Parameters:

{Event} event

- the event triggered

---

Parameters:

{Event} event

- the event triggered

---

Parameters:

{Event} event

- the event triggered

---

Parameters:

{Number} figureId

- the id of the updating object

{String} property

- (or an {Array} of {String}s). The 'id' under which the property is stored TODO: is there any case where we are using property as an array ?

{String} newValue

- the new value of the property

---