ui.Slider Extends goog.ui.SliderBase
This creates a slider object.

Inheritance

Constructor

goog.ui.Slider(opt_domHelperopt_labelFn)

Parameters

opt_domHelper : goog.dom.DomHelper=
Optional DOM helper.
opt_labelFn : (function(number):?string)=
An optional function mapping slider values to a description of the value.

Instance Methods

Public Protected Private
Defined in goog.ui.Slider
createThumb_() HTMLDivElement
Creates the thumb element.
Returns: HTMLDivElement  The created thumb element.
code »
createThumbs()
No description.
code »
getCssClass(orient) string
Returns CSS class applied to the slider element.
Arguments:
orient : goog.ui.SliderBase.Orientation
Orientation of the slider.
Returns: string  The CSS class applied to the slider element.
code »
addRangeHighlightAnimations_(thumbpreviousValuepreviousExtentnewCoordanimations)
Adds animations for the range highlight element to the animation queue.
Arguments:
thumb : Element
The thumb that's moving, must be either valueThumb or extentThumb.
previousValue : number
The previous value of the slider.
previousExtent : number
The previous extent of the slider.
newCoord : goog.math.Coordinate
The new pixel coordinate of the thumb that's moving.
animations : goog.fx.AnimationParallelQueue
The animation queue.
code »
animatedSetValue(v)
Sets the value and starts animating the handle towards that position.
Arguments:
v : number
Value to set and animate to.
code »
calculateRangeHighlightPositioning_(firstThumbPossecondThumbPosthumbSize) {offset: number, size: number
Calculates the start position (offset) and size of the range highlight, e.g. for a horizontal slider, this will return [left, width] for the highlight.
Arguments:
firstThumbPos : number
The position of the first thumb along the slider axis.
secondThumbPos : number
The position of the second thumb along the slider axis, must be >= firstThumbPos.
thumbSize : number
The size of the thumb, along the slider axis.
Returns: {offset: number, size: number  } The positioning parameters for the range highlight.
code »
createDom()
No description.
code »
createThumbs()
Subclasses must implement this method and set the valueThumb and extentThumb to non-null values. They can also set the rangeHighlight element if a range highlight is desired.
code »
decorateInternal()
No description.
code »
disposeInternal()
No description.
code »
enableEventHandlers_(enable)
Attaches/Detaches the event handlers on the slider.
Arguments:
enable : boolean
Whether to attach or detach the event handlers.
code »
enableFlipForRtl(flipForRtl)
Enables/disables true RTL behavior. This should be called immediately after construction. This is a temporary flag to allow clients to transition to the new behavior at their convenience. At some point it will be the default.
Arguments:
flipForRtl : boolean
True if the slider should be flipped for RTL, false otherwise.
code »
enableMouseWheelHandling_(enable)
Enable/Disable mouse wheel handling.
Arguments:
enable : boolean
Whether to enable mouse wheel handling.
code »
endAnimation_(e)
Sets the isAnimating_ field to false once the animation is done.
Arguments:
e : goog.fx.AnimationEvent
Event object passed by the animation object.
code »
enterDocument()
Called when the DOM for the component is for sure in the document. Subclasses should override this method to set this element's role.
code »
exitDocument()
No description.
code »
getBlockIncrement() number
No description.
Returns: number  The amount to increment/decrement for page up/down as well as when holding down the mouse button on the background.
code »
getClosestThumb_(position) HTMLDivElement
No description.
Arguments:
position : number
The position to get the closest thumb to.
Returns: HTMLDivElement  The thumb that is closest to the given position.
code »
getCssClass(orient) string
Returns the CSS class applied to the slider element for the given orientation. Subclasses must override this method.
Arguments:
orient : goog.ui.SliderBase.Orientation
The orientation.
Returns: string  The CSS class applied to slider elements.
code »
getExtent() number
No description.
Returns: number  The value of the extent of the underlying range model.
code »
getExtentThumb() HTMLDivElement
No description.
Returns: HTMLDivElement  The extent thumb element.
code »
getMaximum() number
No description.
Returns: number  The maximum value.
code »
getMinimum() number
No description.
Returns: number  The minimum value.
code »
getMoveToPointEnabled() boolean
No description.
Returns: boolean  Whether clicking on the backgtround should move directly to that point.
code »
getOffsetStart_(element) number
No description.
Arguments:
element : Element
An element for which we want offsetLeft.
Returns: number  Returns the element's offsetLeft, accounting for RTL if flipForRtl_ is true.
code »
getOrientation() goog.ui.SliderBase.Orientation
No description.
Returns: goog.ui.SliderBase.Orientation  the orientation of the slider.
code »
getRelativeMousePos_(e) number
Returns the relative mouse position to the slider.
Arguments:
e : goog.events.Event
The mouse event object.
Returns: number  The relative mouse position to the slider.
code »
getStep() ?number
No description.
Returns: ?number  The step value used to determine how to round the value.
code »
getTextValue() ?string
No description.
Returns: ?string  The text value for the slider's current value, or null if unavailable.
code »
getThumbCoordinateForValue(val) !goog.math.Coordinate
Returns the position to move the handle to for a given value
Arguments:
val : number
The value to get the coordinate for.
Returns: !goog.math.Coordinate  Coordinate with either x or y set.
code »
getThumbCoordinateForValue_()
Since 25-June-2012. Use public method getThumbCoordinateForValue. No description.
code »
getThumbPosition_(thumb) number
No description.
Arguments:
thumb : HTMLDivElement
The thumb object.
Returns: number  The position of the specified thumb.
code »
getUnitIncrement() number
No description.
Returns: number  The amount to increment/decrement for up, down, left and right arrow keys and mouse wheel events.
code »
getValue() number
No description.
Returns: number  The value of the underlying range model.
code »
getValueFromMousePosition(e) number
Returns the value to use for the current mouse position
Arguments:
e : goog.events.Event
The mouse event object.
Returns: number  The value that this mouse position represents.
code »
getValueFromMousePosition_()
Since 25-June-2012. Use public method getValueFromMousePosition. No description.
code »
getValueThumb() HTMLDivElement
No description.
Returns: HTMLDivElement  The value thumb element.
code »
handleBeforeDrag_(e)
Handler for the before drag event. We use the event properties to determine the new value.
Arguments:
e : goog.fx.DragEvent
The drag event used to drag the thumb.
code »
handleKeyDown_(e)
Event handler for the key down event. This is used to update the value based on the key pressed.
Arguments:
e : goog.events.KeyEvent
The keyboard event object.
code »
handleMouseDownAndClick_(e)
Handler for the mouse down event and click event.
Arguments:
e : goog.events.Event
The mouse event object.
code »
handleMouseWheel_(e)
Handler for the mouse wheel event.
Arguments:
e : goog.events.MouseWheelEvent
The mouse wheel event object.
code »
handleRangeModelChange(e)
Call back when the internal range model changes. Sub-classes may override and re-enter this method to update a11y state. Consider protected.
Arguments:
e : goog.events.Event
The event object.
code »
handleThumbDragStartEnd_(e)
Handler for the start/end drag event on the thumgs. Adds/removes the "-dragging" CSS classes on the slider and thumb.
Arguments:
e : goog.fx.DragEvent
The drag event used to drag the thumb.
code »
handleTimerTick_()
Handler for the tick event dispatched by the timer used to update the value in a block increment. This is also called directly from startBlockIncrementing_.
code »
isAnimating() boolean
No description.
Returns: boolean  True if the slider is animating, false otherwise.
code »
isDragging() boolean
Returns whether a thumb is currently being dragged with the mouse (or via touch). Note that changing the value with keyboard, mouswheel, or via move-to-point click immediately sends a CHANGE event without going through a dragged state.
Returns: boolean  Whether a dragger is currently being dragged.
code »
isEnabled() boolean
No description.
Returns: boolean  Whether the slider is enabled or not.
code »
isHandleMouseWheel() boolean
No description.
Returns: boolean  Whether the slider handles mousewheel.
code »
labelFn_()
A function mapping slider values to text description.
code »
moveThumbs(delta)
Moves the thumbs by the specified delta as follows - as long as both thumbs stay within [min,max], both thumbs are moved - once a thumb reaches or exceeds min (or max, respectively), it stays - at min (or max, respectively). In case both thumbs have reached min (or max), no change event will fire. If the specified delta is smaller than the step size, it will be rounded to the step size.
Arguments:
delta : number
The delta by which to move the selected range.
code »
setAdditionalAnimations(factory)
Sets the factory that will be used to create additional animations to be played when animating to a new value. These animations can be for any element and the animations will be played in addition to the default animation(s). The animations will also be played in the same parallel queue ensuring that all animations are played at the same time.
Arguments:
factory : goog.ui.SliderBase.AnimationFactory
The animation factory to use. This will not change the default animations played by the slider. It will only allow for additional animations.
code »
setAriaRoles()
Set a11y roles and state.
code »
setBlockIncrement(value)
Sets the amount to increment/decrement for page up/down as well as when holding down the mouse button on the background.
Arguments:
value : number
The value to set the block increment to.
code »
setEnabled(enable)
Enables or disables the slider. A disabled slider will ignore all user-initiated events. Also fires goog.ui.Component.EventType.ENABLE/DISABLE event as appropriate.
Arguments:
enable : boolean
Whether to enable the slider or not.
code »
setExtent(extent)
Sets the extent of the underlying range model. We enforce that getMinExtent() <= extent <= getMaximum() - getValue() If this is not satisifed for the given extent, the call is ignored and no CHANGE event fires.
Arguments:
extent : number
The value to which to set the extent.
code »
setHandleMouseWheel(enable)
Enables or disables mouse wheel handling for the slider. The mouse wheel handler enables the user to change the value of slider using a mouse wheel.
Arguments:
enable : boolean
Whether to enable mouse wheel handling.
code »
setMaximum(max)
Sets the maximum number.
Arguments:
max : number
The maximum value.
code »
setMinExtent(value)
Sets the minimal value that the extent may have.
Arguments:
value : number
The minimal value for the extent.
code »
setMinimum(min)
Sets the minimum number.
Arguments:
min : number
The minimum value.
code »
setMoveToPointEnabled(val)
Sets whether clicking on the background should move directly to that point.
Arguments:
val : boolean
Whether clicking on the background should move directly to that point.
code »
setOrientation(orient)
Changes the orientation.
Arguments:
orient : goog.ui.SliderBase.Orientation
The orientation.
code »
setStep(step)
Sets the step value. The step value is used to determine how to round the value.
Arguments:
step : ?number
The step size.
code »
setThumbPosition_(thumbposition)
Sets the position of the given thumb. The set is ignored and no CHANGE event fires if it violates the constraint minimum <= value (valueThumb position) <= value + extent (extentThumb position) <= maximum. Note: To keep things simple, the setThumbPosition_ function does not have the side-effect of "correcting" value or extent to fit the above constraint as it is the case in the underlying range model. Instead, we simply ignore the call. Callers must make these adjustements explicitly if they wish.
Arguments:
thumb : Element
The thumb whose position to set.
position : number
The position to move the thumb to.
code »
setUnitIncrement(value)
Sets the amount to increment/decrement for up, down, left and right arrow keys and mouse wheel events.
Arguments:
value : number
The value to set the unit increment to.
code »
setValue(value)
Sets the value of the underlying range model. We enforce that getMinimum() <= value <= getMaximum() - getExtent() If this is not satisifed for the given value, the call is ignored and no CHANGE event fires.
Arguments:
value : number
The value.
code »
setValueAndExtent(valueextent)
Sets the value and extent of the underlying range model. We enforce that getMinimum() <= value <= getMaximum() - extent and getMinExtent <= extent <= getMaximum() - getValue() If this is not satisfied for the given extent, the call is ignored and no CHANGE event fires. This is a utility method to allow setting the thumbs simultaneously and ensuring that only one event fires.
Arguments:
value : number
The value to which to set the value.
extent : number
The value to which to set the extent.
code »
setVisible(visible)
Change the visibility of the slider. You must call this if you had set the slider's value when it was invisible.
Arguments:
visible : boolean
Whether to show the slider.
code »
startBlockIncrementing_(e)
Starts the animation that causes the thumb to increment/decrement by the block increment when the user presses down on the background.
Arguments:
e : goog.events.Event
The mouse event object.
code »
stopBlockIncrementing_()
Stops the block incrementing animation and unlistens the necessary event handlers.
code »
storeMousePos_(e)
Stores the current mouse position so that it can be used in the timer.
Arguments:
e : goog.events.Event
The mouse event object.
code »
updateAriaStates()
Set a11y roles and state when values change.
code »
updateUi_()
This is called when we need to update the size of the thumb. This happens when first created as well as when the value and the orientation changes.
code »
addChild(childopt_render)
Adds the specified component as the last child of this component. See goog.ui.Component#addChildAt for detailed semantics.
Arguments:
child : goog.ui.Component
The new child component.
opt_render : boolean=
If true, the child component will be rendered into the parent.
code »
addChildAt(childindexopt_render) void
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:
  • the child component's element must be a descendant of the parent component's element, and
  • the DOM state of the child component must be consistent with the DOM state of the parent component (see isInDocument) in the steady state -- the exception is to addChildAt(child, i, false) and then immediately decorate/render the child.
In particular, 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:
child : goog.ui.Component
The new child component.
index : number
0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive).
opt_render : boolean=
If true, the child component will be rendered into the parent.
Returns: void  Nada.
code »
canDecorate(element) boolean
Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.
Arguments:
element : Element
Element to decorate.
Returns: boolean  True if the element can be decorated, false otherwise.
code »
createDom()
Creates the initial DOM representation for the component. The default implementation is to set this.element_ = div.
code »
decorate(element)
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:
element : Element
Element to decorate.
code »
decorateInternal(element)
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:
element : Element
Element to decorate.
code »
disposeInternal()
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 »
enterDocument()
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 »
exitDocument()
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 »
forEachChild(fopt_obj)
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:
f : function(this:T,?,number):?
The function to call for every child component; should take 2 arguments (the child and its index).
opt_obj : T=
Used as the 'this' object in f when called.
code »
getChild(id) ?goog.ui.Component
Returns the child with the given ID, or null if no such child exists.
Arguments:
id : string
Child component ID.
Returns: ?goog.ui.Component  The child with the given ID; null if none.
code »
getChildAt(index) ?goog.ui.Component
Returns the child at the given index, or null if the index is out of bounds.
Arguments:
index : number
0-based index.
Returns: ?goog.ui.Component  The child at the given index; null if none.
code »
getChildCount() number
Returns the number of children of this component.
Returns: number  The number of children.
code »
getChildIds() !Array.<string>
Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.
Returns: !Array.<string>  Child component IDs.
code »
getContentElement() Element
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 »
getDomHelper() !goog.dom.DomHelper
Returns the dom helper that is being used on this component.
Returns: !goog.dom.DomHelper  The dom helper used on this component.
code »
getElement() Element
Gets the component's element.
Returns: Element  The element for the component.
code »
getElementByClass(className) Element
Returns the first element in this component's DOM with the provided className.
Arguments:
className : string
The name of the class to look for.
Returns: Element  The first item with the class name provided.
code »
getElementByFragment(idFragment) Element
Helper function for returning an element in the document with a unique id generated using makeId().
Arguments:
idFragment : string
The partial id.
Returns: Element  The element with the unique id, or null if it cannot be found.
code »
getElementStrict() !Element
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 »
getElementsByClass(className) !goog.array.ArrayLike
Returns an array of all the elements in this component's DOM with the provided className.
Arguments:
className : string
The name of the class to look for.
Returns: !goog.array.ArrayLike  The items found with the class name provided.
code »
getFragmentFromId(id) string
Helper function for returning the fragment portion of an id generated using makeId().
Arguments:
id : string
Id generated with makeId().
Returns: string  Fragment.
code »
getHandler() !goog.events.EventHandler.<T>
Returns the event handler for this component, lazily created the first time this method is called.
Returns: !goog.events.EventHandler.<T>  Event handler for this component.
code »
getId() string
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 »
getModel() *
Returns the model associated with the UI component.
Returns: *  The model.
code »
getParent() ?goog.ui.Component
Returns the component's parent, if any.
Returns: ?goog.ui.Component  The parent component.
code »
getRequiredElementByClass(className) !Element
Similar to getElementByClass except that it expects the element to be present in the dom thus returning a required value. Otherwise, will assert.
Arguments:
className : string
The name of the class to look for.
Returns: !Element  The first item with the class name provided.
code »
hasChildren() boolean
Returns true if the component has children.
Returns: boolean  True if the component has children.
code »
indexOfChild(child) number
Returns the 0-based index of the given child component, or -1 if no such child is found.
Arguments:
child : ?goog.ui.Component
The child component.
Returns: number  0-based index of the child component; -1 if not found.
code »
isInDocument() boolean
Determines whether the component has been added to the document.
Returns: boolean  TRUE if rendered. Otherwise, FALSE.
code »
isRightToLeft() boolean
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 »
makeId(idFragment) string
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.
Arguments:
idFragment : string
A partial id.
Returns: string  Unique element id.
code »
makeIds(object) !Object
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.
Arguments:
object : Object
The object that will be used to create the ids.
Returns: !Object  An object of id keys to generated ids.
code »
removeChild(childopt_unrender) goog.ui.Component
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:
child : string | goog.ui.Component | null
The ID of the child to remove, or the child component itself.
opt_unrender : boolean=
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: goog.ui.Component  The removed component, if any.
code »
removeChildAt(indexopt_unrender) goog.ui.Component
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:
index : number
0-based index of the child to remove.
opt_unrender : boolean=
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: goog.ui.Component  The removed component, if any.
code »
removeChildren(opt_unrender) !Array.<goog.ui.Component>
Removes every child component attached to this one and returns them.
Arguments:
opt_unrender : boolean=
If true, calls #exitDocument on the removed child components, and detaches their DOM from the document.
Returns: !Array.<goog.ui.Component>  The removed components if any.
code »
render(opt_parentElement)
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:
opt_parentElement : Element=
Optional parent element to render the component into.
code »
renderBefore(sibling)
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:
sibling : Node
Node to render the component before.
code »
render_(opt_parentElementopt_beforeNode)
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:
opt_parentElement : Element=
Optional parent element to render the component into.
opt_beforeNode : Node=
Node before which the component is to be rendered. If left out the node is appended to the parent element.
code »
setElementInternal(element)
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:
element : Element
Root element for the component.
code »
setId(id)
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:
id : string
Unique component ID.
code »
setModel(obj)
Sets the model associated with the UI component.
Arguments:
obj : *
The model.
code »
setParent(parent)
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:
parent : goog.ui.Component
The parent component.
code »
setParentEventTarget()
Overrides goog.events.EventTarget#setParentEventTarget to throw an error if the parent component is set, and the argument is not the parent.
code »
setRightToLeft(rightToLeft)
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:
rightToLeft : boolean
Whether the component is rendered right-to-left.
code »
wasDecorated() boolean
No description.
Returns: boolean  Whether the component was decorated.
code »
addEventListener(typeopt_captureopt_handlerScope)
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:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
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 »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
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 »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
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:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
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 »
disposeInternal()
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 »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.ui.Slider
constructor :
No description.
Code »
MOUSE_DOWN_DELAY_ :
The delay after mouseDownTime_ during which a click event is ignored.
Code »
additionalAnimations_ : goog.ui.SliderBase.AnimationFactory
The factory to use to generate additional animations when animating to a new value.
Code »
blockIncrement_ :
The amount to increment/decrement for page up/down as well as when holding down the mouse button on the background.
Code »
constructor :
No description.
Code »
enabled_ :
Whether the slider is enabled or not.
Code »
extentDragger_ : goog.fx.Dragger
The Dragger for dragging the extentThumb.
Code »
extentThumb :
The maxThumb dom-element, pointing to the end of the selected range.
Code »
flipForRtl_ :
Whether the slider implements the changes described in http://b/6324964, making it truly RTL. This is a temporary flag to allow clients to transition to the new behavior at their convenience. At some point it will be the default.
Code »
isAnimating_ :
If we are currently animating the thumb.
Code »
isHandleMouseWheel_ :
Whether the slider should handle mouse wheel events.
Code »
keyHandler_ : goog.events.KeyHandler
The object handling keyboard events.
Code »
minExtent_ :
The minimal extent. The class will ensure that the extent cannot shrink to a value smaller than minExtent.
Code »
mouseDownTime_ :
The time the last mousedown event was received.
Code »
mouseWheelHandler_ : goog.events.MouseWheelHandler
The object handling mouse wheel events.
Code »
moveToPointEnabled_ :
Whether clicking on the backgtround should move directly to that point.
Code »
orientation_ :
Orientation of the slider.
Code »
rangeHighlight :
The dom-element highlighting the selected range.
Code »
rangeModel : goog.ui.RangeModel
The underlying range model
Code »
thumbToMove_ :
The thumb that we should be moving (only relevant when timed move is active).
Code »
unitIncrement_ :
The amount to increment/decrement for up, down, left and right arrow keys and mouse wheel events.
Code »
valueDragger_ : goog.fx.Dragger
The Dragger for dragging the valueThumb.
Code »
valueThumb :
The minThumb dom-element, pointing to the start of the selected range.
Code »
childIndex_ :
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 »
children_ :
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 »
constructor :
No description.
Code »
DomHelper used to interact with the document, allowing components to be created in a different window.
Code »
element_ :
The DOM element for the component.
Code »
googUiComponentHandler_ : goog.events.EventHandler
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 »
idGenerator_ : goog.ui.IdGenerator
Generator for unique IDs.
Code »
id_ :
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 »
inDocument_ :
Whether the component is in the document.
Code »
model_ :
Arbitrary data object associated with the component. Such as meta-data.
Code »
parent_ : goog.ui.Component
Parent component to which events will be propagated. This property is strictly private and must not be accessed directly outside of this class!
Code »
rightToLeft_ :
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 »
wasDecorated_ :
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 »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
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 »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.ui.Slider.CSS_CLASS_PREFIX :
The prefix we use for the CSS class names for the slider and its elements.
Code »
goog.ui.Slider.THUMB_CSS_CLASS :
CSS class name for the single thumb element.
Code »
goog.ui.Slider.superClass_ :
No description.
Code »

Enumerations

goog.ui.Slider.Orientation :
Expose Enum of superclass (representing the orientation of the slider) within Slider namespace.
Constants:
Code »

Package ui

Package Reference