Gets or sets a property that causes the canvas to automatically pan the view when the mouse gets dragged within the autoDragInsets of the canvas.

See also

Gets or sets the auto drag insets.

If the mouse is being dragged within the insets of the canvas specified using this field, the control will automatically scroll.

See also

Determines whether the mouse wheel should be used for zooming. If set to false this task can be performed by custom IInputMode implementations using the CanvasMouseEvent of type CanvasMouseEvent.CANVAS_MOUSE_WHEEL.

The default value is true.

Sets the alpha value of the canvas background color.

The default value is 1.0.

Sets the background color of the canvas.

The world coordinate at the center of the canvas component.

Can be used to move the view port.

Gets and sets the Rectangle in world coordinates that holds the contents.

This influences the display of the scroll bars. If the content rectangle is not currently visible in the viewport, scroll bars will be displayed, unless they are turned off completely.

Returns an implementation of ICanvasContext that describes the state of this canvas control.

Get or set the cursor instance that will be displayed for this canvas.

The cursor is shown if the mouse pointer is currently located in the canvas area or if the user started a dragging gesture over the canvas.

Note that when this property is set, cursorManager.removeAllCursors() will be called to ensure that the new cursor is actually displayed.

See also

The size of the area within which the user must click twice for the two clicks to be considered a double-click.

See also

The time that may elapse between two consecutive mouse clicks so the last click is still considered a double click.

See also

The area in view coordinates the mouse may stay in before a movement is considered a drag. If the mouse is moved within this area longer than dragTime milliseconds, the movement will be considered a drag, nevertheless The larger the area the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press.

The default value is (5,5).

See also

The value of the drag time. This value indicates the amount of time in milliseconds that may pass before a mouse movement is considered a drag when the mouse stays within its dragSize area. The higher the value the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press.

The default value is 300.

See also

Property that sets the editable state of this canvas.

IInputMode implementations should honor this property. Events will still be delivered to the IInputModes, however they should not modify the model.

Specifies the radius of the area around the mouse in view coordinates in which an IHitTestable may lie to be considered a valid hit.

This value can be queried from within the IHitTestable implementation from the ICanvasContext.hitTestRadius

The default value is 4.0.

The amount to scroll when an arrow button of the horizontal scrollbar is pressed, in pixels.

Specifies the amount to scroll when the horizontal scroll bar track is pressed, in pixels.

Specifies the visibility policy for the horizontal scrollbar.

See also

The current position of the horizontal scroll bar. This is equal to the distance in pixels between the left edge of the scrollable surface and the leftmost piece of the surface that is currently visible.

The default value is 0.

Specifies the single IInputMode instance that shall be installed for this canvas.

The InputModeContext property.

This context object is passed to IInputMode instances during installation and removal.

If the field has not yet been initialized upon first access, the factory method createInputModeContext will be called.

Upon change the onInputModeContextChanged method will be called.

See also

Retrieves the LookupChain that can be used to decorate the lookup call in the inputModeContext.

Returns the internal list of currently installed IInputModes.

This is a mutable list. To install new instances simply add them to the list and remove them to uninstall them.

See also

Gets the last CanvasMouseEvent that was dispatched by this instance.

The maxZoom property.

The zoom property cannot be set to a value greater than maxZoom.

The default value is 500.

The minZoom property.

The zoom property cannot be set to a value less than minZoom.

The factor by which the zoom level changes when the mouse wheel is turned. The default value is 1.2.

Property that determines whether the whole canvasObjectTree is redrawn upon the next invocation of updateDisplayList().

Property that determines whether the canvasObjectTree is redrawn partially upon the next invocation of updateDisplayList().

The amount to scroll when an arrow button of the vertical scrollbar is pressed, in pixels.

Specifies the amount to scroll when the vertical scroll bar track is pressed, in pixels.

Specifies the visibility policy for the vertical scrollbar.

See also

The current position of the vertical scroll bar. This is equal to the distance in pixels between the top edge of the scrollable surface and the topmost piece of the surface that is currently visible.

The default value is 0.

The current view point. The view point is the point in world coordinates that is mapped to the top left corner point in the current viewport.

Returns the currently visible viewing region in world coordinates.

The zoom factor for this canvas control.

A zoom level of 1.0 will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide.

If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates.

The default value is 1.0.

This property can be used as the source for data binding.

Whether the mouse wheel triggers zooming whenever the mouse is over the canvas area (true) or whether the canvas needs focus to trigger zooming (false).

When the canvas component has focus, the mouse wheel will always trigger zooming.

The default value is true.

Constructor.

Adds an element to the internal canvas object tree to the specified group.

The descriptor will be queried for the various implementations for the given userObject at rendering time.

Adds a new ICanvasObjectGroup to the root of the canvas object tree.

Adds a new ICanvasObjectGroup to the specified group in the current canvas object tree. Can be used to build hgroups of ICanvasObject's that can be moved within the canvas object tree.

Adds an IPaintable instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor. This method is equivalent to calling addCanvasObject(object,ICanvasObjectDescriptor) with CanvasObjectDescriptor.instance as the second argument an a non-null first argument.

Adjusts the mouse cursor based on the given mouse event and the cursor property.

Collects all canvas object instances that are hit at the given coordinate set.

Factory method for the InputModeContext property. This method will be called upon first access to the inputModeContext property.

Creates a sprite containing a complete copy of the current canvas object tree.

This method is useful for custom printing. The created sprite can be transformed and added to a flash.printing.PrintJob.

Unregister all event listeners that were registered with the stage. This method is called whenever this canvas component is removed from the display list.

Adjusts the view port to fully encompass the current content rectangle. The zoom level will be at least 1.

Updates the content rectangle and adjusts the viewport to encompass the contents.

This method combines the calls to updateContentRect() and fitContent().

See also

Invalidates this canvas component and causes a repaint of all display objects that are visible in this canvas component.

Returns the top most canvas object instance that is hit at the given coordinate set.

Returns a list of all canvas objects in hit order at the given world coordinate location.

The order of the elements in the list is the natural hit test order, i.e. elements painted on top of others will be reported first in the list.

Returns a rectangle defined by the available space for displaying the CanvasObjectTree within this Component, in stage coordinates.

Returns an array of ICanvasObjects that are hit by the given coords.

Note that this method uses the flas internal hit test which may be faster than using getCanvasObject/getCanvasObjects

Initialize all event listeners that should be registered with the stage. This method is called whenever this canvas component is added to the display list.

Callback that is used by the default implementation of inputModeContext to resolve lookup calls.

See also

Marks a component so that its updateDisplayList() method gets called during a later screen update.

Checks whether the point at stageX,stageY is within the canvas bounds and target is a child of the canvas.

Iterates all hit elements in the canvas below the given group that are accepted by a given filter. Hit testing is performed using the IHitTestable instance returned for each visible ICanvasObject in the current scene graph.

See also

If the autoMouseWheelZoom property is set to true, this method will adjust the current zoom level. If the Ctrl key modifier has been pressed this method will keep the world coordinates at the current mouse position, i.e. the zoom will not necessarily be into the center of the canvas.

Called when the component is added to the display list.

Calls initListeners, passing the stage as the eventDispatcher.

Called when the autoDrag property changes.

Dispatches the CanvasComponent.AUTO_DRAG_CHANGED event.

See also

Called when the autoDragInsets property changes.

Dispatches the CanvasComponent.AUTO_DRAG_INSETS_CHANGED event.

See also

Callback method that is called when the mouse has been clicked. The clickCount property of the event can be queried to determine whether a double click has occured.

This callback will be called after the onMouseUp() method has been invoked and only if the mouse has not been moved by a great amount since the last onMouseDown event.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_CLICK event. Subclasses overriding this method should make sure to invoke the super class implementation.

See also

Callback method that is called when a mouse button has been pressed.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_DOWN event. Subclasses overriding this method should make sure to invoke the super class implementation.

See also

Callback method that is called when the mouse gets dragged. Moving the mouse while at least one button is pressed is considered dragging.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_DRAG event. Subclasses overriding this method should make sure to invoke the super class implementation.

See also

Callback method that is called when the mouse has been moved and the mouse button has not been pressed. If the mouse button has been pressed, onCanvasMouseDragged method would have been called instead.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_MOVE event. Subclasses overriding this method should make sure to invoke the super class implementation.

See also