width
: string | number
The (non-zero) width in pixels. Strings
expressing percentages of parent with (e.g. '80%') are also accepted.
|
height
: string | number
The (non-zero) height in pixels. Strings
expressing percentages of parent with (e.g. '80%') are also accepted.
|
opt_coordWidth
: ?number=
The coordinate width - if
omitted or null, defaults to same as width.
|
opt_coordHeight
: ?number=
The coordinate height - if
omitted or null, defaults to same as height.
|
opt_domHelper
: goog.dom.DomHelper=
The DOM helper object for the
document we want to render in.
|
![]()
Append an element.
Arguments:
|
code » | |||||||||||
![]()
Use append instead.
Append an element.
Arguments:
|
code » | |||||||||||
![]()
Remove all drawing elements from the graphics.
|
code » | |||||||||||
![]()
Clears the drawing context object in response to actions that make the old
context invalid - namely resize of the canvas element.
|
code » | |||||||||||
![]()
Creates the DOM representation of the graphics area.
|
code » | |||||||||||
Create an empty group of drawing elements.
Arguments:
Returns: !goog.graphics.CanvasGroupElement
The newly created group.
|
code » | |||||||||||
![]()
Disposes of the component by removing event handlers, detacing DOM nodes from
the document body, and removing references to them.
|
code » | |||||||||||
![]()
Draw an element, including any stroke or fill.
Arguments:
|
code » | |||||||||||
Draw an ellipse.
Arguments:
Returns: !goog.graphics.EllipseElement
The newly created element.
|
code » | |||||||||||
Draw an image.
Arguments:
Returns: !goog.graphics.ImageElement
The newly created element.
|
code » | |||||||||||
Draw a path.
Arguments:
Returns: !goog.graphics.PathElement
The newly created element.
|
code » | |||||||||||
Draw a rectangle.
Arguments:
Returns: !goog.graphics.RectElement
The newly created element.
|
code » | |||||||||||
![]()
Draw a text string vertically centered on a given line.
Arguments:
Returns: !goog.graphics.TextElement
The newly created element.
|
code » | |||||||||||
![]()
No description.
|
code » | |||||||||||
Returns the drawing context.
Returns: Object
The canvas element rendering context.
|
code » | |||||||||||
![]()
No description.
|
code » | |||||||||||
![]()
Measure and return the width (in pixels) of a given text string.
Text measurement is needed to make sure a text can fit in the allocated
area. The way text length is measured is by writing it into a div that is
after the visible area, measure the div width, and immediatly erase the
written value.
Arguments:
|
code » | |||||||||||
No description.
Arguments:
Returns: boolean
Whether drawing can occur now.
|
code » | |||||||||||
Returns true if drawing to the given group means a redraw is required.
Arguments:
Returns: boolean
Whether drawing to this group should force a redraw.
|
code » | |||||||||||
![]()
Pop an element transform off of the transform stack.
|
code » | |||||||||||
![]()
Push an element transform on to the transform stack.
Arguments:
|
code » | |||||||||||
![]()
Redraw the entire canvas.
|
code » | |||||||||||
![]()
Reset the canvas.
|
code » | |||||||||||
![]()
Stop preventing redraws. If any redraws had been prevented, a redraw will
be done now.
|
code » | |||||||||||
![]()
Changes the coordinate system position.
|
code » | |||||||||||
![]()
Changes the coordinate size.
|
code » | |||||||||||
![]()
Sets the fill for the given element.
Arguments:
|
code » | |||||||||||
![]()
Sets the stroke for the given element.
Arguments:
|
code » | |||||||||||
![]()
Set the transformation of an element.
Arguments:
|
code » | |||||||||||
![]()
Change the size of the canvas.
|
code » | |||||||||||
![]()
Start preventing redraws - useful for chaining large numbers of changes
together. Not guaranteed to do anything - i.e. only use this for
optimization of a single code path.
|
code » | |||||||||||
![]()
Update the size of the canvas.
|
code » |
Create an empty group of drawing elements.
Arguments:
Returns: goog.graphics.GroupElement
The newly created group.
|
code » | ||||||||||||
Use
new goog.graphics.Path() .
Create an empty path.
Returns: !goog.graphics.Path
The path.
|
code » | ||||||||||||
Draw a circle
Arguments:
Returns: goog.graphics.EllipseElement
The newly created element.
|
code » | ||||||||||||
Draw an ellipse
Arguments:
Returns: goog.graphics.EllipseElement
The newly created element.
|
code » | ||||||||||||
Draw a path.
Arguments:
Returns: goog.graphics.PathElement
The newly created element.
|
code » | ||||||||||||
Draw a rectangle
Arguments:
Returns: goog.graphics.RectElement
The newly created element.
|
code » | ||||||||||||
![]()
Draw a text string within a rectangle (drawing is horizontal)
Arguments:
Returns: goog.graphics.TextElement
The newly created element.
|
code » | ||||||||||||
![]()
Draw a text string vertically centered on a given line.
Arguments:
Returns: goog.graphics.TextElement
The newly created element.
|
code » | ||||||||||||
No description.
Returns: goog.graphics.GroupElement
The root level canvas element.
|
code » | ||||||||||||
No description.
Returns: !goog.math.Coordinate
The coordinate system position.
|
code » | ||||||||||||
No description.
Returns: goog.math.Size
The coordinate size.
|
code » | ||||||||||||
No description.
Returns: number
Returns the number of pixels per unit in the x direction.
|
code » | ||||||||||||
No description.
Returns: number
Returns the number of pixels per unit in the y direction.
|
code » | ||||||||||||
No description.
Returns: ?goog.math.Size
Returns the number of pixels spanned by the
surface, or null if the size could not be computed due to the size being
specified in percentage points and the component not being in the
document.
|
code » | ||||||||||||
Use getPixelSize.
No description.
Returns: goog.math.Size
The size of canvas.
|
code » | ||||||||||||
Measure and return the width (in pixels) of a given text string.
Text measurement is needed to make sure a text can fit in the allocated
area. The way text length is measured is by writing it into a div that is
after the visible area, measure the div width, and immediatly erase the
written value.
Arguments:
Returns: number
The width in pixels of the text strings.
|
code » | ||||||||||||
No description.
Returns: boolean
Whether the underlying element can be cloned resulting in
an accurate reproduction of the graphics contents.
|
code » | ||||||||||||
![]()
Remove a single drawing element from the surface. The default implementation
assumes a DOM based drawing surface.
Arguments:
|
code » | ||||||||||||
![]()
Stop preventing redraws. If any redraws had been prevented, a redraw will
be done now.
|
code » | ||||||||||||
![]()
Changes the coordinate system position.
|
code » | ||||||||||||
![]()
Changes the coordinate size.
|
code » | ||||||||||||
![]()
Sets the fill for the given element.
Arguments:
|
code » | ||||||||||||
![]()
Sets the stroke for the given element.
Arguments:
|
code » | ||||||||||||
![]()
Set the transformation of an element.
Arguments:
|
code » | ||||||||||||
![]()
Change the size of the canvas.
|
code » | ||||||||||||
![]()
Start preventing redraws - useful for chaining large numbers of changes
together. Not guaranteed to do anything - i.e. only use this for
optimization of a single code path.
|
code » |
![]()
Adds the specified component as the last child of this component. See
goog.ui.Component#addChildAt for detailed semantics.
Arguments:
|
code » | ||||
![]()
Adds the specified component as a child of this component at the given
0-based index.
Both
addChild and addChildAt assume the following contract
between parent and child components:
parent.addChild(child) will throw an error if the
child component is already in the document, but the parent isn't.
Clients of this API may call addChild and addChildAt with
opt_render set to true. If opt_render is true, calling these
methods will automatically render the child component's element into the
parent component's element. If the parent does not yet have an element, then
createDom will automatically be invoked on the parent before
rendering the child.
Invoking parent.addChild(child, true) will throw an error if the
child component is already in the document, regardless of the parent's DOM
state.
If opt_render is true and the parent component is not already
in the document, enterDocument will not be called on this component
at this point.
Finally, this method also throws an error if the new child already has a
different parent, or the given index is out of bounds.
Arguments:
Returns: void
Nada.
|
code » | ||||
Determines if a given element can be decorated by this type of component.
This method should be overridden by inheriting objects.
|
code » | ||||
![]()
Creates the initial DOM representation for the component. The default
implementation is to set this.element_ = div.
|
code » | ||||
![]()
Decorates the element for the UI component. If the element is in the
document, the enterDocument method will be called.
If goog.ui.Component.ALLOW_DETACHED_DECORATION is false, the caller must
pass an element that is in the document.
Arguments:
|
code » | ||||
![]()
Actually decorates the element. Should be overridden by inheriting objects.
This method can assume there are checks to ensure the component has not
already been rendered have occurred and that enter document will be called
afterwards. This method is considered protected.
Arguments:
|
code » | ||||
![]()
Disposes of the component. Calls
exitDocument , which is expected to
remove event handlers and clean up the component. Propagates the call to
the component's children, if any. Removes the component's DOM from the
document unless it was decorated.
|
code » | ||||
![]()
Called when the component's element is known to be in the document. Anything
using document.getElementById etc. should be done at this stage.
If the component contains child components, this call is propagated to its
children.
|
code » | ||||
![]()
Called by dispose to clean up the elements and listeners created by a
component, or by a parent component/application who has removed the
component from the document but wants to reuse it later.
If the component contains child components, this call is propagated to its
children.
It should be possible for the component to be rendered again once this method
has been called.
|
code » | ||||
![]()
Calls the given function on each of this component's children in order. If
opt_obj is provided, it will be used as the 'this' object in the
function when called. The function should take two arguments: the child
component and its 0-based index. The return value is ignored.
Arguments:
|
code » | ||||
Returns the child with the given ID, or null if no such child exists.
Arguments:
Returns: ?goog.ui.Component
The child with the given ID; null if none.
|
code » | ||||
Returns the child at the given index, or null if the index is out of bounds.
Arguments:
Returns: ?goog.ui.Component
The child at the given index; null if none.
|
code » | ||||
Returns the number of children of this component.
Returns: number
The number of children.
|
code » | ||||
Returns an array containing the IDs of the children of this component, or an
empty array if the component has no children.
|
code » | ||||
Returns the DOM element into which child components are to be rendered,
or null if the component itself hasn't been rendered yet. This default
implementation returns the component's root element. Subclasses with
complex DOM structures must override this method.
Returns: Element
Element to contain child elements (null if none).
|
code » | ||||
Returns the dom helper that is being used on this component.
Returns: !goog.dom.DomHelper
The dom helper used on this component.
|
code » | ||||
Gets the component's element.
Returns: Element
The element for the component.
|
code » | ||||
Returns the first element in this component's DOM with the provided
className.
|
code » | ||||
Helper function for returning an element in the document with a unique id
generated using makeId().
|
code » | ||||
Gets the component's element. This differs from getElement in that
it assumes that the element exists (i.e. the component has been
rendered/decorated) and will cause an assertion error otherwise (if
assertion is enabled).
Returns: !Element
The element for the component.
|
code » | ||||
![]()
Returns an array of all the elements in this component's DOM with the
provided className.
Arguments:
Returns: !goog.array.ArrayLike
The items found with the class name provided.
|
code » | ||||
Helper function for returning the fragment portion of an id generated using
makeId().
|
code » | ||||
Returns the event handler for this component, lazily created the first time
this method is called.
|
code » | ||||
Gets the unique ID for the instance of this component. If the instance
doesn't already have an ID, generates one on the fly.
Returns: string
Unique component ID.
|
code » | ||||
![]()
Returns the model associated with the UI component.
Returns: *
The model.
|
code » | ||||
Returns the component's parent, if any.
Returns: ?goog.ui.Component
The parent component.
|
code » | ||||
Similar to
getElementByClass except that it expects the
element to be present in the dom thus returning a required value. Otherwise,
will assert.
|
code » | ||||
Returns true if the component has children.
Returns: boolean
True if the component has children.
|
code » | ||||
Returns the 0-based index of the given child component, or -1 if no such
child is found.
Arguments:
Returns: number
0-based index of the child component; -1 if not found.
|
code » | ||||
Determines whether the component has been added to the document.
Returns: boolean
TRUE if rendered. Otherwise, FALSE.
|
code » | ||||
Returns true if the component is rendered right-to-left, false otherwise.
The first time this function is invoked, the right-to-left rendering property
is set if it has not been already.
Returns: boolean
Whether the control is rendered right-to-left.
|
code » | ||||
Helper function for subclasses that gets a unique id for a given fragment,
this can be used by components to generate unique string ids for DOM
elements.
|
code » | ||||
Makes a collection of ids. This is a convenience method for makeId. The
object's values are the id fragments and the new values are the generated
ids. The key will remain the same.
|
code » | ||||
Removes the given child from this component, and returns it. Throws an error
if the argument is invalid or if the specified child isn't found in the
parent component. The argument can either be a string (interpreted as the
ID of the child component to remove) or the child component itself.
If
opt_unrender is true, calls goog.ui.component#exitDocument
on the removed child, and subsequently detaches the child's DOM from the
document. Otherwise it is the caller's responsibility to clean up the child
component's DOM.
Arguments:
Returns: goog.ui.Component
The removed component, if any.
|
code » | ||||
Removes the child at the given index from this component, and returns it.
Throws an error if the argument is out of bounds, or if the specified child
isn't found in the parent. See
goog.ui.Component#removeChild for
detailed semantics.
Arguments:
Returns: goog.ui.Component
The removed component, if any.
|
code » | ||||
Removes every child component attached to this one and returns them.
Arguments:
|
code » | ||||
![]()
Renders the component. If a parent element is supplied, the component's
element will be appended to it. If there is no optional parent element and
the element doesn't have a parentNode then it will be appended to the
document body.
If this component has a parent component, and the parent component is
not in the document already, then this will not call
enterDocument
on this component.
Throws an Error if the component is already rendered.
Arguments:
|
code » | ||||
![]()
Renders the component before another element. The other element should be in
the document already.
Throws an Error if the component is already rendered.
Arguments:
|
code » | ||||
![]()
Renders the component. If a parent element is supplied, the component's
element will be appended to it. If there is no optional parent element and
the element doesn't have a parentNode then it will be appended to the
document body.
If this component has a parent component, and the parent component is
not in the document already, then this will not call
enterDocument
on this component.
Throws an Error if the component is already rendered.
Arguments:
|
code » | ||||
![]()
Sets the component's root element to the given element. Considered
protected and final.
This should generally only be called during createDom. Setting the element
does not actually change which element is rendered, only the element that is
associated with this UI component.
This should only be used by subclasses and its associated renderers.
Arguments:
|
code » | ||||
![]()
Assigns an ID to this component instance. It is the caller's responsibility
to guarantee that the ID is unique. If the component is a child of a parent
component, then the parent component's child index is updated to reflect the
new ID; this may throw an error if the parent already has a child with an ID
that conflicts with the new ID.
Arguments:
|
code » | ||||
![]()
Sets the model associated with the UI component.
Arguments:
|
code » | ||||
![]()
Sets the parent of this component to use for event bubbling. Throws an error
if the component already has a parent or if an attempt is made to add a
component to itself as a child. Callers must use
removeChild
or removeChildAt to remove components from their containers before
calling this method.
Arguments:
|
code » | ||||
![]()
Overrides
goog.events.EventTarget#setParentEventTarget to throw an
error if the parent component is set, and the argument is not the parent.
|
code » | ||||
![]()
Set is right-to-left. This function should be used if the component needs
to know the rendering direction during dom creation (i.e. before
#enterDocument is called and is right-to-left is set).
Arguments:
|
code » | ||||
No description.
Returns: boolean
Whether the component was decorated.
|
code » |
![]()
Use
#listen instead, when possible. Otherwise, use
goog.events.listen if you are passing Object
(instead of Function) as handler.
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.
Arguments:
|
code » | |||||
![]()
Asserts that the event target instance is initialized properly.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
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.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget
The parent EventTarget or null if
there is no parent.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
Use
#unlisten instead, when possible. Otherwise, use
goog.events.unlisten if you are passing Object
(instead of Function) as handler.
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.
Arguments:
|
code » | |||||
![]()
Sets the parent of this event target to use for capture/bubble
mechanism.
Arguments:
|
code » | |||||
![]()
Sets the target to be used for
event.target when firing
event. Mainly used for testing. For example, see
goog.testing.events.mixinListenable .
Arguments:
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » |
![]()
Invokes a callback function when this object is disposed. Callbacks are
invoked in the order in which they were added.
Arguments:
|
code » | |||
![]()
Disposes of the object. If the object hasn't already been disposed of, calls
#disposeInternal . Classes that extend goog.Disposable should
override #disposeInternal in order to delete references to COM
objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void
Nothing.
|
code » | |||
![]()
Deletes or nulls out any references to COM objects, DOM nodes, or other
disposable objects. Classes that extend
goog.Disposable should
override this method.
Not reentrant. To avoid calling it twice, it must only be called from the
subclass' disposeInternal method. Everywhere else the public
dispose method must be used.
For example:
mypackage.MyClass = function() { mypackage.MyClass.base(this, 'constructor'); // Constructor logic specific to MyClass. ... }; goog.inherits(mypackage.MyClass, goog.Disposable); mypackage.MyClass.prototype.disposeInternal = function() { // Dispose logic specific to MyClass. ... // Call superclass's disposeInternal at the end of the subclass's, like // in C++, to avoid hard-to-catch issues. mypackage.MyClass.base(this, 'disposeInternal'); }; |
code » | |||
Use
#isDisposed instead.
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
![]()
Associates a disposable object with this object so that they will be disposed
together.
Arguments:
|
code » |
The root level group element.
|
Code » | |
![]()
Remove all drawing elements from the graphics.
|
Code » | |
![]()
No description.
|
Code » | |
![]()
Height of coordinate system in units.
|
Code » | |
![]()
Left coordinate of the view box
|
Code » | |
![]()
Top coordinate of the view box
|
Code » | |
![]()
Width of coordinate system in units.
|
Code » | |
![]()
Height of graphics in pixels or precentage points.
|
Code » | |
![]()
Width of graphics in pixels or percentage points.
|
Code » |
![]()
Map of child component IDs to child components. Used for constant-time
random access to child components by ID. Lazily initialized on first use.
Must be kept in sync with
children_ . This property is strictly
private and must not be accessed directly outside of this class!
We use a plain Object, not a goog.structs.Map , for simplicity.
This means components can't have children with IDs such as 'constructor' or
'valueOf', but this shouldn't really be an issue in practice, and if it is,
we can always fix it later without changing the API.
|
Code » | |
![]()
Array of child components. Lazily initialized on first use. Must be kept in
sync with
childIndex_ . This property is strictly private and must
not be accessed directly outside of this class!
|
Code » | |
![]()
No description.
|
Code » | |
DomHelper used to interact with the document, allowing components to be
created in a different window.
|
Code » | |
![]()
The DOM element for the component.
|
Code » | |
Event handler.
TODO(user): rename it to handler_ after all component subclasses in
inside Google have been cleaned up.
Code search: http://go/component_code_search
|
Code » | |
Generator for unique IDs.
|
Code » | |
![]()
Unique ID of the component, lazily initialized in
goog.ui.Component#getId if needed. This property is strictly private and
must not be accessed directly outside of this class!
|
Code » | |
![]()
Whether the component is in the document.
|
Code » | |
![]()
Arbitrary data object associated with the component. Such as meta-data.
|
Code » | |
Parent component to which events will be propagated. This property is
strictly private and must not be accessed directly outside of this class!
|
Code » | |
![]()
Whether the component is rendered right-to-left. Right-to-left is set
lazily when
#isRightToLeft is called the first time, unless it has
been set by calling #setRightToLeft explicitly.
|
Code » | |
![]()
Flag used to keep track of whether a component decorated an already existing
element or whether it created the DOM itself.
If an element is decorated, dispose will leave the node in the document.
It is up to the app to remove the node.
If an element was rendered, dispose will remove the node automatically.
|
Code » |
The object to use for event.target. Useful when mixing in an
EventTarget to another object.
|
Code » | |
![]()
No description.
|
Code » | |
Maps of event type to an array of listeners.
|
Code » | |
Parent event target, used during event bubbling.
TODO(user): Change this to goog.events.Listenable. This
currently breaks people who expect getParentEventTarget to return
goog.events.EventTarget.
|
Code » |
![]()
No description.
|
Code » |