goog.graphics.ext.Element

Provided By	`goog.graphics.ext.Element`
Extends	`goog.events.EventTarget` `goog.Disposable`
All Implemented Interfaces	`goog.disposable.IDisposable` `goog.events.Listenable`
All Known Direct Subclasses	`goog.graphics.ext.Group` `goog.graphics.ext.Image` `goog.graphics.ext.StrokeAndFillElement`

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.

Deprecated	Use `#listen` instead, when possible. Otherwise, use `goog.events.listen` if you are passing Object (instead of Function) as handler.

Defined by

goog.events.EventTarget

Parameters

`type`	`(string\|goog.events.EventId)`
	The type of the event to listen for
`handler`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
`opt_capture`	`boolean=`
	In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
`opt_handlerScope`	`(Object\|null)=`
	Object in whose scope to call the listener.

VIEW SOURCE

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Defined by

goog.Disposable

Parameters

`callback`	`function(): ?`
	The callback function.
`opt_scope`	`(T\|null)=`
	An optional scope to call the callback in.

VIEW SOURCE

Overridable function for subclass specific parent dependency.

Parameters

None.

Returns

boolean

Whether this shape's bounds depends on its parent's.

VIEW SOURCE

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`e`	`(string\|Object\|null)`
	Event object.

Returns

boolean

If anyone called preventDefault on the event object (or if any of the listeners returns false) this will also return false.

VIEW SOURCE

Disposes of the object and its resources.

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

Nothing.

VIEW SOURCE

Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

Overrides	`goog.events.EventTarget`
Parameters	None.

VIEW SOURCE

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)`
	The type of the listeners to fire.
`capture`	`boolean`
	The capture mode of the listeners to fire.
`eventObject`	`(EVENTOBJ\|null)`
	The event object to fire.

Returns

boolean

Whether all listeners succeeded without attempting to prevent default behavior. If any listener returns false or called goog.events.Event#preventDefault, this returns false.

VIEW SOURCE

Parameters

None.

Returns

number

The bottom coordinate of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The center coordinate of the element, in units of the parent's coordinate system.

VIEW SOURCE

Deprecated	Use `#isDisposed` instead.

Defined by

goog.Disposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

Parameters

None.

Returns

(goog.graphics.ext.Element|null)

The graphics surface the element is a part of.

VIEW SOURCE

Returns the graphics implementation.

Parameters

None.

Returns

(goog.graphics.AbstractGraphics|null)

The underlying graphics implementation drawing this element's wrapper.

VIEW SOURCE

Parameters

None.

Returns

number

The height of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The distance from the left edge of this element to the left edge of its parent, specified in units of the parent's coordinate system.

VIEW SOURCE

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)`
	The name of the event without the 'on' prefix.
`listener`	`function((EVENTOBJ\|null)): (boolean\|undefined)`
	The listener function to get.
`capture`	`boolean`
	Whether the listener is a capturing listener.
`opt_listenerScope`	`(SCOPE\|null)=`
	Object in whose scope to call the listener.

Returns

(goog.events.ListenableKey|null)

the found listener or null if not found.

VIEW SOURCE

Gets all listeners in this listenable for the given type and capture mode.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId)`
	The type of the listeners to fire.
`capture`	`boolean`
	The capture mode of the listeners to fire.

Returns

Array<goog.events.ListenableKey>

An array of registered listeners.

VIEW SOURCE

Parameters

None.

Returns

number

An estimate of the maximum x extent this element would have in a parent of no width.

VIEW SOURCE

Parameters

None.

Returns

number

An estimate of the maximum y extent this element would have in a parent of no height.

VIEW SOURCE

Parameters

None.

Returns

number

The middle coordinate of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The minimum height of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The minimum width of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

(goog.graphics.ext.Group|null|undefined)

The parent of this element.

VIEW SOURCE

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

None.

Returns

(goog.events.Listenable|null)

The parent EventTarget or null if there is no parent.

VIEW SOURCE

Parameters

None.

Returns

number

Returns the number of pixels per unit in the x direction.

VIEW SOURCE

Parameters

None.

Returns

number

Returns the number of pixels per unit in the y direction.

VIEW SOURCE

Parameters

None.

Returns

number

The right coordinate of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The angle of rotation of this element, in degrees.

VIEW SOURCE

Parameters

None.

Returns

number

The distance from the top edge of this element to the top edge of its parent, specified in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

number

The width of the element, in units of the parent's coordinate system.

VIEW SOURCE

Parameters

None.

Returns

(goog.graphics.Element|null)

The underlying thin wrapper.

VIEW SOURCE

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`opt_type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)=`
	Event type.
`opt_capture`	`boolean=`
	Whether to check for capture or bubble listeners.

Returns

boolean

Whether there is any active listeners matching the requested type and/or capture phase.

VIEW SOURCE

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

Returns whether this element's bounds depend on its parents.

This function should be treated as if it has package scope.

Parameters

None.

Returns

boolean

Whether this element's bounds depend on its parents.

VIEW SOURCE

Parameters

None.

Returns

boolean

Whether this element has pending transforms.

VIEW SOURCE

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)`
	The event type id.
`listener`	`function((EVENTOBJ\|null)): (boolean\|undefined)`
	Callback method.
`opt_useCapture`	`boolean=`
	Whether to fire in capture phase (defaults to false).
`opt_listenerScope`	`(SCOPE\|null)=`
	Object in whose scope to call the listener.

Returns

goog.events.ListenableKey

Unique key for the listener.

VIEW SOURCE

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)`
	The event type id.
`listener`	`function((EVENTOBJ\|null)): (boolean\|undefined)`
	Callback method.
`opt_useCapture`	`boolean=`
	Whether to fire in capture phase (defaults to false).
`opt_listenerScope`	`(SCOPE\|null)=`
	Object in whose scope to call the listener.

Returns

goog.events.ListenableKey

Unique key for the listener.

VIEW SOURCE

Called by the parent when the parent has transformed.

Should be treated as package scope.

VIEW SOURCE

Overridable function for subclass specific reset.

VIEW SOURCE

Associates a disposable object with this object so that they will be disposed together.

Defined by

goog.Disposable

Parameters

`disposable`	`(goog.disposable.IDisposable\|null)`
	that will be disposed when this object is disposed.

VIEW SOURCE

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`opt_type`	`(string\|goog.events.EventId)=`
	Type of event to remove, default is to remove all types.

Returns

number

Number of listeners removed.

VIEW SOURCE

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

Deprecated	Use `#unlisten` instead, when possible. Otherwise, use `goog.events.unlisten` if you are passing Object (instead of Function) as handler.

Defined by

goog.events.EventTarget

Parameters

`type`	`(string\|goog.events.EventId)`
	The type of the event to listen for
`handler`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
`opt_capture`	`boolean=`
	In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
`opt_handlerScope`	`(Object\|null)=`
	Object in whose scope to call the listener.

VIEW SOURCE

Reset the element. This is called when the element changes size, or when the coordinate system changes in a way that would affect pixel based rendering

VIEW SOURCE

Sets the bottom coordinate of the element. Overwrites any previous value of top, middle, or bottom for this element.

Parameters

`bottom`	`(string\|number)`
	The bottom coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Shortcut for setting the left, top, width, and height.

Parameters

`left`	`(string\|number)`
	The left coordinate.
`top`	`(string\|number)`
	The top coordinate.
`width`	`(string\|number)`
	The new width value.
`height`	`(string\|number)`
	The new height value.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the center coordinate of the element. Overwrites any previous value of left, center, or right for this element.

Parameters

`center`	`(string\|number)`
	The center coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the height of the element.

Parameters

`height`	`(string\|number)`
	The new height value.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the left coordinate of the element. Overwrites any previous value of left, center, or right for this element.

Parameters

`left`	`(string\|number)`
	The left coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the middle coordinate of the element. Overwrites any previous value of top, middle, or bottom for this element

Parameters

`middle`	`(string\|number)`
	The middle coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the minimum height of the element.

Parameters

`minHeight`	`(string\|number)`
	The minimum height of the element.

VIEW SOURCE

Sets the minimum width of the element.

Parameters

`minWidth`	`(string\|number)`
	The minimum width of the element.

VIEW SOURCE

Sets the parent of this event target to use for capture/bubble mechanism.

Defined by

goog.events.EventTarget

Parameters

`parent`	`(goog.events.EventTarget\|null)`
	Parent listenable (null if none).

VIEW SOURCE

Shortcut for setting the left and top position.

Parameters

`left`	`(string\|number)`
	The left coordinate.
`top`	`(string\|number)`
	The top coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the right coordinate of the element. Overwrites any previous value of left, center, or right for this element.

Parameters

`right`	`(string\|number)`
	The right coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Set the rotation of this element.

Parameters

`angle`	`number`
	The angle of rotation, in degrees.

VIEW SOURCE

Shortcut for setting the width and height.

Parameters

`width`	`(string\|number)`
	The new width value.
`height`	`(string\|number)`
	The new height value.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Defined by

goog.events.EventTarget

Parameters

`target`	`Object`
	The target.

VIEW SOURCE

Sets the top coordinate of the element. Overwrites any previous value of top, middle, or bottom for this element.

Parameters

`top`	`(string\|number)`
	The top coordinate.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Sets the width of the element.

Parameters

`width`	`(string\|number)`
	The new width value.
`opt_chain`	`boolean=`
	Optional flag to specify this function is part of a chain of calls and therefore transformations should be set as pending but not yet performed.

VIEW SOURCE

Performs a pending transform.

VIEW SOURCE

Removes an event listener which was added with listen() or listenOnce().

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>)`
	The event type id.
`listener`	`function((EVENTOBJ\|null)): (boolean\|undefined)`
	Callback method.
`opt_useCapture`	`boolean=`
	Whether to fire in capture phase (defaults to false).
`opt_listenerScope`	`(SCOPE\|null)=`
	Object in whose scope to call the listener.

Returns

boolean

Whether any listener was removed.

VIEW SOURCE

Removes an event listener which was added with listen() by the key returned by listen().

Overrides

goog.events.EventTarget

Specified by

goog.events.Listenable

Parameters

`key`	`goog.events.ListenableKey`
	The key returned by listen() or listenOnce().

Returns

boolean

Whether any listener was removed.

VIEW SOURCE

goog.graphics.ext.Element

new Element( group, wrapper )

Instance Methods

this.addEventListener( type, handler, opt_capture, opt_handlerScope ) → void

this.addOnDisposeCallback<T>( callback, opt_scope ) → void

this.checkParentDependent() → boolean

this.dispatchEvent( e ) → boolean

this.dispose() → ?

this.disposeInternal() → void

this.fireListeners<EVENTOBJ>( type, capture, eventObject ) → boolean

this.getBottom() → number

this.getCenter() → number

this.getDisposed() → boolean

this.getGraphics() → (goog.graphics.ext.Element|null)

this.getGraphicsImplementation() → (goog.graphics.AbstractGraphics|null)

this.getHeight() → number

this.getLeft() → number

this.getListener<SCOPE, EVENTOBJ>( type, listener, capture, opt_listenerScope ) → (goog.events.ListenableKey|null)

this.getListeners<EVENTOBJ>( type, capture ) → Array<goog.events.ListenableKey>

this.getMaxX() → number

this.getMaxY() → number

this.getMiddle() → number

this.getMinHeight() → number

this.getMinWidth() → number

this.getParent() → (goog.graphics.ext.Group|null|undefined)

this.getParentEventTarget() → (goog.events.Listenable|null)

this.getPixelScaleX() → number

this.getPixelScaleY() → number

this.getRight() → number

this.getRotation() → number

this.getTop() → number

this.getWidth() → number

this.getWrapper() → (goog.graphics.Element|null)

this.hasListener<EVENTOBJ>( opt_type, opt_capture ) → boolean

this.isDisposed() → boolean

this.isParentDependent() → boolean

this.isPendingTransform() → boolean

this.listen<SCOPE, EVENTOBJ>( type, listener, opt_useCapture, opt_listenerScope ) → goog.events.ListenableKey

this.listenOnce<SCOPE, EVENTOBJ>( type, listener, opt_useCapture, opt_listenerScope ) → goog.events.ListenableKey

this.parentTransform() → void

this.redraw() → void

this.registerDisposable( disposable ) → void

this.removeAllListeners( opt_type ) → number

this.removeEventListener( type, handler, opt_capture, opt_handlerScope ) → void

this.reset() → void

this.setBottom( bottom, opt_chain ) → void

this.setBounds( left, top, width, height, opt_chain ) → void

this.setCenter( center, opt_chain ) → void

this.setHeight( height, opt_chain ) → void

this.setLeft( left, opt_chain ) → void

this.setMiddle( middle, opt_chain ) → void

this.setMinHeight( minHeight ) → void

this.setMinWidth( minWidth ) → void

this.setParentEventTarget( parent ) → void

this.setPosition( left, top, opt_chain ) → void

this.setRight( right, opt_chain ) → void

this.setRotation( angle ) → void

this.setSize( width, height, opt_chain ) → void

this.setTargetForTesting( target ) → void

this.setTop( top, opt_chain ) → void

this.setWidth( width, opt_chain ) → void

this.transform() → void

this.unlisten<SCOPE, EVENTOBJ>( type, listener, opt_useCapture, opt_listenerScope ) → boolean

this.unlistenByKey( key ) → boolean

Instance Properties

this.creationStack → (string|undefined)

Classes

Enumerations

new Element( `group`, `wrapper` )

`this.`addEventListener( `type`, `handler`, `opt_capture`, `opt_handlerScope` ) `→` `void`

`this.`addOnDisposeCallback`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`checkParentDependent() `→` `boolean`

`this.`dispatchEvent( `e` ) `→` `boolean`

`this.`dispose() `→` `?`

`this.`disposeInternal() `→` `void`

`this.`fireListeners`<EVENTOBJ>`( `type`, `capture`, `eventObject` ) `→` `boolean`

`this.`getBottom() `→` `number`

`this.`getCenter() `→` `number`

`this.`getDisposed() `→` `boolean`

`this.`getGraphics() `→` `(goog.graphics.ext.Element|null)`

`this.`getGraphicsImplementation() `→` `(goog.graphics.AbstractGraphics|null)`

`this.`getHeight() `→` `number`

`this.`getLeft() `→` `number`

`this.`getListener`<SCOPE, EVENTOBJ>`( `type`, `listener`, `capture`, `opt_listenerScope` ) `→` `(goog.events.ListenableKey|null)`

`this.`getListeners`<EVENTOBJ>`( `type`, `capture` ) `→` `Array<goog.events.ListenableKey>`

`this.`getMaxX() `→` `number`

`this.`getMaxY() `→` `number`

`this.`getMiddle() `→` `number`

`this.`getMinHeight() `→` `number`

`this.`getMinWidth() `→` `number`

`this.`getParent() `→` `(goog.graphics.ext.Group|null|undefined)`

`this.`getParentEventTarget() `→` `(goog.events.Listenable|null)`

`this.`getPixelScaleX() `→` `number`

`this.`getPixelScaleY() `→` `number`

`this.`getRight() `→` `number`

`this.`getRotation() `→` `number`

`this.`getTop() `→` `number`

`this.`getWidth() `→` `number`

`this.`getWrapper() `→` `(goog.graphics.Element|null)`

`this.`hasListener`<EVENTOBJ>`( `opt_type`, `opt_capture` ) `→` `boolean`

`this.`isDisposed() `→` `boolean`

`this.`isParentDependent() `→` `boolean`

`this.`isPendingTransform() `→` `boolean`

`this.`listen`<SCOPE, EVENTOBJ>`( `type`, `listener`, `opt_useCapture`, `opt_listenerScope` ) `→` `goog.events.ListenableKey`

`this.`listenOnce`<SCOPE, EVENTOBJ>`( `type`, `listener`, `opt_useCapture`, `opt_listenerScope` ) `→` `goog.events.ListenableKey`

`this.`parentTransform() `→` `void`

`this.`redraw() `→` `void`

`this.`registerDisposable( `disposable` ) `→` `void`

`this.`removeAllListeners( `opt_type` ) `→` `number`

`this.`removeEventListener( `type`, `handler`, `opt_capture`, `opt_handlerScope` ) `→` `void`

`this.`reset() `→` `void`

`this.`setBottom( `bottom`, `opt_chain` ) `→` `void`

`this.`setBounds( `left`, `top`, `width`, `height`, `opt_chain` ) `→` `void`

`this.`setCenter( `center`, `opt_chain` ) `→` `void`

`this.`setHeight( `height`, `opt_chain` ) `→` `void`

`this.`setLeft( `left`, `opt_chain` ) `→` `void`

`this.`setMiddle( `middle`, `opt_chain` ) `→` `void`

`this.`setMinHeight( `minHeight` ) `→` `void`

`this.`setMinWidth( `minWidth` ) `→` `void`

`this.`setParentEventTarget( `parent` ) `→` `void`

`this.`setPosition( `left`, `top`, `opt_chain` ) `→` `void`

`this.`setRight( `right`, `opt_chain` ) `→` `void`

`this.`setRotation( `angle` ) `→` `void`

`this.`setSize( `width`, `height`, `opt_chain` ) `→` `void`

`this.`setTargetForTesting( `target` ) `→` `void`

`this.`setTop( `top`, `opt_chain` ) `→` `void`

`this.`setWidth( `width`, `opt_chain` ) `→` `void`

`this.`transform() `→` `void`

`this.`unlisten`<SCOPE, EVENTOBJ>`( `type`, `listener`, `opt_useCapture`, `opt_listenerScope` ) `→` `boolean`

`this.`unlistenByKey( `key` ) `→` `boolean`

`this.`creationStack `→` `(string|undefined)`