Mixins
A Surface is an interface to render methods inside a draw Ext.draw.Component.
A Surface contains methods to render sprites, get bounding boxes of sprites, add
sprites to the canvas, initialize other graphic components, etc. One of the most used
methods for this class is the add method, to add Sprites to the surface.
Most of the Surface methods are abstract and they have a concrete implementation in VML or SVG engines.
A Surface instance can be accessed as a property of a draw component. For example:
drawComponent.surface.add({
type: 'circle',
fill: '#ffc',
radius: 100,
x: 100,
y: 100
});
The configuration object passed in the add method is the same as described in the Ext.draw.Sprite
class documentation.
You can also add event listeners to the surface using the Observable listener syntax. Supported events are:
For example:
drawComponent.surface.on({
'mousemove': function() {
console.log('moving the mouse over the surface');
}
});
The height of this component in pixels (defaults to auto). Note to express this dimension as a percentage or offset see Ext.Component.anchor.
(optional)
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
DOM events from ExtJs Components
While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the DataView's
click event passing the node clicked on. To access DOM
events directly from a child element of a Component, we need to specify the element option to
identify the Component property to add a DOM listener to:
new Ext.panel.Panel({
width: 400,
height: 200,
dockedItems: [{
xtype: 'toolbar'
}],
listeners: {
click: {
element: 'el', //bind to the underlying el property on the panel
fn: function(){ console.log('click el'); }
},
dblclick: {
element: 'body', //bind to the underlying body property on the panel
fn: function(){ console.log('dblclick body'); }
}
}
});
The width of this component in pixels (defaults to auto). Note to express this dimension as a percentage or offset see Ext.Component.anchor.
Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
For example:
drawComponent.surface.addCls(sprite, 'x-visible');
Add a gradient definition to the Surface. Note that in some surface engines, adding a gradient via this method will not take effect if the surface has already been rendered. Therefore, it is preferred to pass the gradients as an item to the surface config, rather than calling this method, especially if the surface is rendered immediately (e.g. due to 'renderTo' in its config). For more information on how to create gradients in the Chart configuration object please refer to Ext.chart.Chart.
The gradient object to be passed into this method is composed by:
stops - object - An object with numbers as keys (from 0 to 100) and style objects as values.
For example:
drawComponent.surface.addGradient({
id: 'gradientId',
angle: 45,
stops: {
0: {
color: '#555'
},
100: {
color: '#ddd'
}
}
});
Removes one or more CSS classes from the element.
For example:
drawComponent.surface.removeCls(sprite, 'x-visible');
Sets CSS style attributes to an element.
For example:
drawComponent.surface.setStyle(sprite, {
'cursor': 'pointer'
});
Changes the text in the sprite element. The sprite must be a text sprite.
This method can also be called from Ext.draw.Sprite.
For example:
var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');
Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.
For example:
drawComponent.surface.add({
type: 'circle',
fill: '#ffc',
radius: 100,
x: 100,
y: 100
});
Adds the specified events to the list of events which this Observable may fire.
Adds the specified events to the list of events which this Observable may fire.
Either an object with event names as properties with a value of true
or the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:
this.addEvents('storeloaded', 'storecleared');
Appends an event handler to this object.
Appends an event handler to this object.
The name of the event to listen for. May also be an object who's property names are event names. See
The method the event invokes.
(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration. properties. This may contain any of the following properties:
this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
When added in this way, the options available are the options applicable to Ext.core.Element.addListener
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple events. For example:
myGridPanel.on({
cellClick: this.onCellClick,
mouseover: this.onMouseOver,
mouseout: this.onMouseOut,
scope: this // Important. Ensure "this" is correct during handler execution
});
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
The item to which to add a listener/listeners.
The event name, or an object containing event name properties.
Optional. If the ename parameter was an event name, this
is the handler function.
Optional. If the ename parameter was an event name, this
is the scope (this reference) in which the handler function is executed.
Optional. If the ename parameter was an event name, this
is the addListener options.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.
The Observable to capture events from.
The function to call when an event is fired.
(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
Removes all listeners for this object including the managed listeners
Removes all managed listeners for this object.
Removes all managed listeners for this object.
Create and return a new concrete Surface instance appropriate for the current environment.
Create and return a new concrete Surface instance appropriate for the current environment.
Initial configuration for the Surface instance
Optional order of implementations to use; the first one that is
available in the current environment will be used. Defaults to
<code>['Svg', 'Vml']</code>.
Destroys the surface. This is done by removing all components from it and also removing its reference to a DOM element.
For example:
drawComponent.surface.destroy();
Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.
Example:
Ext.override(Ext.form.field.Base, {
// Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
this.enableBubble('change');
}),
// We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
if (!this.formPanel) {
this.formPanel = this.findParentByType('form');
}
return this.formPanel;
}
});
var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
...
}],
listeners: {
change: function() {
// Title goes red if form has been modified.
myForm.header.setStyle('color', 'red');
}
}
});
The event name to bubble, or an Array of event names.
Fires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.
The name of the event to fire.
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Returns a new group or an existent group associated with the current surface. The group returned is a Ext.draw.CompositeSprite group.
For example:
var spriteGroup = drawComponent.surface.getGroup('someGroupId');
The unique identifier of the group.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
The name of the event to check for
True if the event is being listened for, else false
Sets observability on the passed class constructor.
This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.
Usage:
Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
console.log('Ajax request made to ' + options.url);
});
The class constructor to make observable.
An object containing a series of listeners to add. See addListener.
Appends an event handler to this object (shorthand for addListener.)
Appends an event handler to this object (shorthand for addListener.)
The type of event to listen for
The method the event invokes
(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.
The Observable whose events this object is to relay.
Array of event names to relay.
Removes all added captures from the Observable.
Removes all added captures from the Observable.
The Observable to release
Remove a given sprite from the surface, optionally destroying the sprite in the process.
You can also call the sprite own remove method.
For example:
drawComponent.surface.remove(sprite);
//or...
sprite.remove();
the sprite's new index in the list
Remove all sprites from the surface, optionally destroying the sprites in the process.
For example:
drawComponent.surface.removeAll();
Whether to destroy all sprites when removing them.
The sprite's new index in the list.
Removes an event handler.
Removes an event handler.
The type of event the handler was associated with.
The handler to remove. This must be a reference to the function passed into the addListener call.
(optional) The scope originally specified for the handler.
Removes listeners that were added by the mon method.
Removes listeners that were added by the mon method.
The item from which to remove a listener/listeners.
The event name, or an object containing event name properties.
Optional. If the ename parameter was an event name, this
is the handler function.
Optional. If the ename parameter was an event name, this
is the scope (this reference) in which the handler function is executed.
Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now.
Sets the size of the surface. Accomodates the background (if any) to fit the new size too.
For example:
drawComponent.surface.setSize(500, 500);
This method is generally called when also setting the size of the draw Component.
The new width of the canvas.
The new height of the canvas.
Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;
Removes an event handler (shorthand for removeListener.)
Removes an event handler (shorthand for removeListener.)
The type of event the handler was associated with.
The handler to remove. This must be a reference to the function passed into the addListener call.
(optional) The scope originally specified for the handler.