X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.draw.engine.Vml.html diff --git a/docs/api/Ext.draw.engine.Vml.html b/docs/api/Ext.draw.engine.Vml.html new file mode 100644 index 00000000..20deebf6 --- /dev/null +++ b/docs/api/Ext.draw.engine.Vml.html @@ -0,0 +1,518 @@ +Ext.draw.engine.Vml | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Hierarchy

Ext.draw.Surface
Ext.draw.engine.Vml

Mixins

Provides specific methods to draw with VML.

+
Defined By

Config Options

Other Configs

 
The height of this component in pixels (defaults to auto). +Note to express this dimension as a percentage or offset s...

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. T...

(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 se...

The width of this component in pixels (defaults to auto). +Note to express this dimension as a percentage or offset see Ext.Component.anchor.

+
Defined By

Properties

 
Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. + +For example: + + dr...

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 n...

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:

+ +
    +
  • id - string - The unique name of the gradient.
  • +
  • angle - number, optional - The angle of the gradient in degrees.
  • +
  • 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'...

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': 'poi...

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.dra...

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');
+
+
Defined By

Methods

 
Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method. + +For exa...

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
+});
+
+

Returns

  • void    +
 
addEvents( +Object/String o, String ) + : void

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.

+

Parameters

  • o : Object/String

    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.

    +
  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. +Usage:

    + +
    this.addEvents('storeloaded', 'storecleared');
    +
    + +

Returns

  • void    +
 
addGradient( +Object gradient) + : void
Adds a definition to this Surface for a linear gradient. We convert the gradient definition +to its corresponding VML ...

Adds a definition to this Surface for a linear gradient. We convert the gradient definition +to its corresponding VML attributes and store it for later use by individual sprites.

+

Parameters

  • gradient : Object
    +

Returns

  • void    +
 
addListener( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object.

+

Appends an event handler to this object.

+

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

    +
  • handler : Function

    The method the event invokes.

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

    (optional) An object containing handler configuration. +properties. This may contain any of the following properties:

      +
    • scope : Object
      The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.
    • +
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • +
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • +
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed +by the specified number of milliseconds. If the event fires again within that time, the original +handler is not invoked, but the new handler is scheduled in its place.
    • +
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not +if the event was bubbled up from a child Observable.
    • +
    • element : String
      This option is only valid for listeners bound to Components. +The name of a Component property which references an element to add a listener to.

      + +

      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
    +});
    +
    . +

    + +

Returns

  • void    +
 
addManagedListener( +Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) + : void

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. + +

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

    +
  • ename : Object/String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

    Optional. If the ename parameter was an event name, this +is the scope (this reference) in which the handler function is executed.

    +
  • opt : Object

    Optional. If the ename parameter was an event name, this +is the addListener options.

    +

Returns

  • void    +
 
capture( +Observable o, Function fn, [Object scope]) + : void
Starts capture on the specified Observable. All events will be passed +to the supplied function with the event name + ...

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.

+

Parameters

  • o : Observable

    The Observable to capture events from.

    +
  • fn : Function

    The function to call when an event is fired.

    +
  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

    +

Returns

  • void    +
 

Removes all listeners for this object including the managed listeners

+

Removes all listeners for this object including the managed listeners

+

Returns

  • void    +
 

Removes all managed listeners for this object.

+

Removes all managed listeners for this object.

+

Returns

  • void    +
 
create( +Object config, Array enginePriority) + : void

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.

+

Parameters

  • config : Object

    Initial configuration for the Surface instance

    +
  • enginePriority : Array

    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>.
    +
    +

Returns

  • void    +
 
Destroys the surface. This is done by removing all components from it and +also removing its reference to a DOM elemen...

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();
+
+

Returns

  • void    +
 
enableBubble( +String/Array events) + : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling +this.getBubbleTarget() if present....

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');
+    }
+}
+});
+
+ +

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

    +

Returns

  • void    +
 
fireEvent( +String eventName, Object... args) + : Boolean
Fires the specified event with the passed parameters (minus the event name). + + +An event may be set to bubble up an Ob...

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.

+ +

Parameters

  • eventName : String

    The name of the event to fire.

    +
  • args : Object...

    Variable number of parameters are passed to handlers.

    +

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

    +
 
getGroup( +String id) + : Object
Returns a new group or an existent group associated with the current surface. +The group returned is a Ext.draw.Compos...

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');
+
+

Parameters

  • id : String

    The unique identifier of the group.

    +

Returns

 

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.

+

Returns

  • void    +
 
hasListener( +String eventName) + : Boolean

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

+

Parameters

  • eventName : String

    The name of the event to check for

    +

Returns

  • Boolean   

    True if the event is being listened for, else false

    +
 
observe( +Function c, Object listeners) + : void
Sets observability on the passed class constructor. + +This makes any event fired on any instance of the passed class a...

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);
+});
+
+

Parameters

  • c : Function

    The class constructor to make observable.

    +
  • listeners : Object

    An object containing a series of listeners to add. See addListener.

    +

Returns

  • void    +
 
on( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object (shorthand for addListener.)

+

Appends an event handler to this object (shorthand for addListener.)

+

Parameters

  • eventName : String

    The type of event to listen for

    +
  • handler : Function

    The method the event invokes

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

    (optional) An object containing handler configuration.

    +

Returns

  • void    +
 
relayEvents( +Object origin, Array events, Object prefix) + : void

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.

+

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    +
  • events : Array

    Array of event names to relay.

    +
  • prefix : Object
    +

Returns

  • void    +
 

Removes all added captures from the Observable.

+

Removes all added captures from the Observable.

+

Parameters

  • o : Observable

    The Observable to release

    +

Returns

  • void    +
 
remove( +Ext.draw.Sprite sprite, Boolean destroySprite) + : Number
Remove a given sprite from the surface, optionally destroying the sprite in the process. +You can also call the sprite...

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();
+
+

Parameters

  • sprite : Ext.draw.Sprite
    +
  • destroySprite : Boolean
    +

Returns

  • Number   

    the sprite's new index in the list

    +
 
removeAll( +Boolean destroySprites) + : Number
Remove all sprites from the surface, optionally destroying the sprites in the process. + +For example: + + drawComponent....

Remove all sprites from the surface, optionally destroying the sprites in the process.

+ +

For example:

+ +
 drawComponent.surface.removeAll();
+
+

Parameters

  • destroySprites : Boolean

    Whether to destroy all sprites when removing them.

    +

Returns

  • Number   

    The sprite's new index in the list.

    +
 
removeListener( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler.

+

Removes an event handler.

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
 
removeManagedListener( +Observable|Element item, Object|String ename, Function fn, Object scope) + : void

Removes listeners that were added by the mon method.

+

Removes listeners that were added by the mon method.

+

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

    +
  • ename : Object|String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

    Optional. If the ename parameter was an event name, this +is the scope (this reference) in which the handler function is executed.

    +

Returns

  • void    +
 
Resume firing events. (see suspendEvents) +If events were suspended using the queueSuspended parameter, then all +event...

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.

+

Returns

  • void    +
 
setSize( +Number w, Number h) + : void
Sets the size of the surface. Accomodates the background (if any) to fit the new size too. + +For example: + + drawCompon...

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.

+

Parameters

  • w : Number

    The new width of the canvas.

    +
  • h : Number

    The new height of the canvas.

    +

Returns

  • void    +
 
suspendEvents( +Boolean queueSuspended) + : void

Suspend the firing of all events. (see resumeEvents)

+

Suspend the firing of all events. (see resumeEvents)

+

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired +after the resumeEvents call instead of discarding all suspended events;

    +

Returns

  • void    +
 
un( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler (shorthand for removeListener.)

+

Removes an event handler (shorthand for removeListener.)

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
\ No newline at end of file