/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_layout_boxOverflow_VerticalScroller({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":"Ext.layout.boxOverflow.Scroller","uses":[],"html":"

Hierarchy

Ext.layout.boxOverflow.None
Ext.layout.boxOverflow.Scroller
Ext.layout.boxOverflow.VerticalScroller

Files

Description

\n
Defined By

Properties

CSS class added to the afterCt element. ...

CSS class added to the afterCt element. This is the element that holds any special items such as scrollers,\nwhich must always be present at the rightmost edge of the Container

\n

Defaults to: 'x-strip-right'

The left scroller element. ...

The left scroller element. Only created when needed.

\n
CSS class added to the right scroller element if enableScroll is used ...

CSS class added to the right scroller element if enableScroll is used

\n

Defaults to: 'x-strip-scroller-right'

True to animate the scrolling of items within the layout (defaults to true, ignored if enableScroll is false) ...

True to animate the scrolling of items within the layout (defaults to true, ignored if enableScroll is false)

\n

Defaults to: true

CSS class added to the beforeCt element. ...

CSS class added to the beforeCt element. This is the element that holds any special items such as scrollers,\nwhich must always be present at the leftmost edge of the Container

\n

Defaults to: 'x-strip-left'

The left scroller element. ...

The left scroller element. Only created when needed.

\n
CSS class added to the left scroller element if enableScroll is used ...

CSS class added to the left scroller element if enableScroll is used

\n

Defaults to: 'x-strip-scroller-left'

Number of seconds that each scroll animation lasts (defaults to 0.4) ...

Number of seconds that each scroll animation lasts (defaults to 0.4)

\n

Defaults to: 0.4

Ext.layout.boxOverflow.VerticalScroller
view source
: Number
The number of pixels to scroll by on scroller click (defaults to 100) ...

The number of pixels to scroll by on scroller click (defaults to 100)

\n

Defaults to: 75

Overrides: Ext.layout.boxOverflow.Scroller.scrollIncrement

Number of milliseconds between each scroll while a scroller button is held down (defaults to 400) ...

Number of milliseconds between each scroll while a scroller button is held down (defaults to 400)

\n

Defaults to: 400

CSS class added to both scroller elements if enableScroll is used ...

CSS class added to both scroller elements if enableScroll is used

\n

Defaults to: 'x-strip-scroller'

Ext.layout.boxOverflow.VerticalScroller
view source
: Number
The number of pixels to increment on mouse wheel scrolling (defaults to 3). ...

The number of pixels to increment on mouse wheel scrolling (defaults to 3).

\n

Defaults to: 2

Overrides: Ext.layout.boxOverflow.Scroller.wheelIncrement

Defined By

Methods

Ext.layout.boxOverflow.VerticalScroller
view source
( ) : Booleanprivate
Returns true if the innerCt scroll is already at its right-most point ...

Returns true if the innerCt scroll is already at its right-most point

\n

Returns

  • Boolean

    True if already at furthest right point

    \n
Returns true if the innerCt scroll is already at its left-most point ...

Returns true if the innerCt scroll is already at its left-most point

\n

Returns

  • Boolean

    True if already at furthest left point

    \n
Ext.layout.boxOverflow.VerticalScroller
view source
( )private
Creates the beforeCt and afterCt elements if they have not already been created ...

Creates the beforeCt and afterCt elements if they have not already been created

\n
Creates the clickable scroller elements and places them into the beforeCt and afterCt ...

Creates the clickable scroller elements and places them into the beforeCt and afterCt

\n
Sets up an listener to scroll on the layout's innerCt mousewheel event ...

Sets up an listener to scroll on the layout's innerCt mousewheel event

\n
Normalizes an item reference, string id or numerical index into a reference to the item ...

Normalizes an item reference, string id or numerical index into a reference to the item

\n

Parameters

Returns

For a given item in the container, return an object with information on whether the item is visible\nwith the current ...

For a given item in the container, return an object with information on whether the item is visible\nwith the current innerCt scroll value.

\n

Parameters

Returns

  • Object

    Values for fullyVisible, hiddenLeft and hiddenRight

    \n
Ext.layout.boxOverflow.VerticalScroller
view source
( ) : Numberprivate
Returns the maximum value we can scrollTo ...

Returns the maximum value we can scrollTo

\n

Returns

...
\n

Returns

  • Object

    Object passed to scrollTo when scrolling

    \n
Ext.layout.boxOverflow.VerticalScroller
view source
( ) : Number
Returns the current scroll position of the innerCt element ...

Returns the current scroll position of the innerCt element

\n

Returns

  • Number

    The current scroll position

    \n
Ext.layout.boxOverflow.VerticalScroller
view source
( calculations, targetSize )private
Most of the heavy lifting is done in the subclasses ...

Most of the heavy lifting is done in the subclasses

\n

Parameters

  • calculations : Object
    \n
  • targetSize : Object
    \n

Overrides: Ext.layout.boxOverflow.Scroller.handleOverflow

Hides the scroller elements in the beforeCt and afterCt ...

Hides the scroller elements in the beforeCt and afterCt

\n
Scrolls left or right by the number of pixels specified ...

Scrolls left or right by the number of pixels specified

\n

Parameters

  • delta : Number

    Number of pixels to scroll to the right by. Use a negative number to scroll left

    \n
Scrolls to the left by the configured amount ...

Scrolls to the left by the configured amount

\n

Parameters

  • animate : Object
    \n
Scrolls to the right by the configured amount ...

Scrolls to the right by the configured amount

\n

Parameters

  • animate : Object
    \n
Ext.layout.boxOverflow.VerticalScroller
view source
( position, animate )private
Scrolls to the given position. ...

Scrolls to the given position. Performs bounds checking.

\n

Parameters

  • position : Number

    The position to scroll to. This is constrained.

    \n
  • animate : Boolean

    True to animate. If undefined, falls back to value of this.animateScroll

    \n
Scrolls to the given component. ...

Scrolls to the given component.

\n

Parameters

  • item : String|Number|Ext.Component

    The item to scroll to. Can be a numerical index, component id\nor a reference to the component itself.

    \n
  • animate : Boolean

    True to animate the scrolling

    \n
Shows the scroller elements in the beforeCt and afterCt. ...

Shows the scroller elements in the beforeCt and afterCt. Creates the scrollers first if they are not already\npresent.

\n
Enables or disables each scroller button based on the current scroll position ...

Enables or disables each scroller button based on the current scroll position

\n
","superclasses":["Ext.layout.boxOverflow.None","Ext.layout.boxOverflow.Scroller"],"meta":{},"requires":[],"html_meta":{},"statics":{"property":[],"cfg":[],"css_var":[],"method":[],"event":[],"css_mixin":[]},"files":[{"href":"ScrollerOverflow.html#Ext-layout-boxOverflow-VerticalScroller","filename":"ScrollerOverflow.js"}],"linenr":321,"members":{"property":[{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"afterCls","id":"property-afterCls"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"afterScroller","id":"property-afterScroller"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"afterScrollerCls","id":"property-afterScrollerCls"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"animateScroll","id":"property-animateScroll"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"beforeCls","id":"property-beforeCls"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"beforeScroller","id":"property-beforeScroller"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"beforeScrollerCls","id":"property-beforeScrollerCls"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"scrollDuration","id":"property-scrollDuration"},{"tagname":"property","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{},"name":"scrollIncrement","id":"property-scrollIncrement"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"scrollRepeatInterval","id":"property-scrollRepeatInterval"},{"tagname":"property","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"scrollerCls","id":"property-scrollerCls"},{"tagname":"property","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{},"name":"wheelIncrement","id":"property-wheelIncrement"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.layout.boxOverflow.None","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{"private":true},"name":"atExtremeAfter","id":"method-atExtremeAfter"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"atExtremeBefore","id":"method-atExtremeBefore"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"clearOverflow","id":"method-clearOverflow"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{"private":true},"name":"createInnerElements","id":"method-createInnerElements"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"createScrollers","id":"method-createScrollers"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"createWheelListener","id":"method-createWheelListener"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"getItem","id":"method-getItem"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"getItemVisibility","id":"method-getItemVisibility"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{"private":true},"name":"getMaxScrollBottom","id":"method-getMaxScrollBottom"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"getScrollAnim","id":"method-getScrollAnim"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{},"name":"getScrollPosition","id":"method-getScrollPosition"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{"private":true},"name":"handleOverflow","id":"method-handleOverflow"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"hideScrollers","id":"method-hideScrollers"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"scrollBy","id":"method-scrollBy"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"scrollLeft","id":"method-scrollLeft"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"scrollRight","id":"method-scrollRight"},{"tagname":"method","owner":"Ext.layout.boxOverflow.VerticalScroller","meta":{"private":true},"name":"scrollTo","id":"method-scrollTo"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{},"name":"scrollToItem","id":"method-scrollToItem"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"showScrollers","id":"method-showScrollers"},{"tagname":"method","owner":"Ext.layout.boxOverflow.Scroller","meta":{"private":true},"name":"updateScrollButtons","id":"method-updateScrollButtons"}],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.layout.boxOverflow.VerticalScroller","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.layout.boxOverflow.VerticalScroller","mixins":[],"mixedInto":[]});