dijit/layout/ScrollingTabController.js

• Provides:

  • dijit.layout.ScrollingTabController

• Requires:

  • dijit.layout.TabController in common
  • dijit.Menu in common
  • dijit.form.Button in common
  • dijit._HasDropDown in common

• dijit.layout.ScrollingTabController

  • type

    Function

  • chains:
    • dijit.layout.TabController: (prototype)
    • dijit.layout.TabController: (call)
  • summary

    Set of tabs with left/right arrow keys and a menu to switch between tabs not
    all fitting on a single row.
    Works only for horizontal tabs (either above or below the content, not to the left
    or right).

  • tags:

• dijit.layout.ScrollingTabController.templateString

  • type

    Object

• dijit.layout.ScrollingTabController.useMenu

  • tags: const
  • type

    Boolean

  • summary

    True if a menu should be used to select tabs when they are too
    wide to fit the TabContainer, false otherwise.

• dijit.layout.ScrollingTabController.useSlider

  • tags: const
  • type

    Boolean

  • summary

    True if a slider should be used to select tabs when they are too
    wide to fit the TabContainer, false otherwise.

• dijit.layout.ScrollingTabController.tabStripClass

  • tags: const
  • type

    String

  • summary

    The css class to apply to the tab strip, if it is visible.

• dijit.layout.ScrollingTabController.widgetsInTemplate

  • type

    Object

• dijit.layout.ScrollingTabController._minScroll

  • type

    Number

  • summary

    The distance in pixels from the edge of the tab strip which,
    if a scroll animation is less than, forces the scroll to
    go all the way to the left/right.

• dijit.layout.ScrollingTabController.attributeMap

  • type

    Object

• dijit.layout.ScrollingTabController.buildRendering

  • type

    Function

• dijit.layout.ScrollingTabController.domNode

• dijit.layout.ScrollingTabController.scrollNode

• dijit.layout.ScrollingTabController.onStartup

  • type

    Function

• dijit.layout.ScrollingTabController._postStartup

  • type

    Object

• dijit.layout.ScrollingTabController.onAddChild

  • parameters:
    • page
    • insertIndex
  • type

    Function

• dijit.layout.ScrollingTabController.onRemoveChild

  • parameters:
    • page
    • insertIndex
  • type

    Function

• dijit.layout.ScrollingTabController._selectedTab

  • type

    Object

• dijit.layout.ScrollingTabController._initButtons

  • summary

    Creates the buttons used to scroll to view tabs that
    may not be visible if the TabContainer is too narrow.

  • type

    Function

• dijit.layout.ScrollingTabController._btnWidth

  • type

    Number

• dijit.layout.ScrollingTabController._buttons

  • type

    Object

• dijit.layout.ScrollingTabController._getTabsWidth

  • type

    Function

• dijit.layout.ScrollingTabController._enableBtn

  • parameters:
    • width
  • summary

    Determines if the tabs are wider than the width of the TabContainer, and
    thus that we need to display left/right/menu navigation buttons.

  • type

    Function

• dijit.layout.ScrollingTabController.resize

  • parameters:
    • dim
  • summary

    Hides or displays the buttons used to scroll the tab list and launch the menu
    that selects tabs.

  • type

    Function

• dijit.layout.ScrollingTabController._dim

• dijit.layout.ScrollingTabController.scrollNode.style.height

  • type

    String

• dijit.layout.ScrollingTabController._contentBox

  • type

    Object

• dijit.layout.ScrollingTabController._contentBox.h

• dijit.layout.ScrollingTabController._leftBtn.layoutAlign

  • type

    String

• dijit.layout.ScrollingTabController._rightBtn.layoutAlign

  • type

    String

• dijit.layout.ScrollingTabController._menuBtn.layoutAlign

• dijit.layout.ScrollingTabController.scrollNode.scrollLeft

• dijit.layout.ScrollingTabController._postResize

  • type

    Object

• dijit.layout.ScrollingTabController._getScroll

  • summary

    Returns the current scroll of the tabs where 0 means
    "scrolled all the way to the left" and some positive number, based on #
    of pixels of possible scroll (ex: 1000) means "scrolled all the way to the right"

  • type

    Function

• dijit.layout.ScrollingTabController._convertToScrollLeft

  • parameters:
    • val
  • summary

    Given a scroll value where 0 means "scrolled all the way to the left"
    and some positive number, based on # of pixels of possible scroll (ex: 1000)
    means "scrolled all the way to the right", return value to set this.scrollNode.scrollLeft
    to achieve that scroll.
    
    This method is to adjust for RTL funniness in various browsers and versions.

  • type

    Function

• dijit.layout.ScrollingTabController.onSelectChild

  • parameters:
    • page: (typeof dijit._Widget)
  • summary

    Smoothly scrolls to a tab when it is selected.

  • type

    Function

• dijit.layout.ScrollingTabController._getScrollBounds

  • summary

    Returns the minimum and maximum scroll setting to show the leftmost and rightmost
    tabs (respectively)

  • type

    Function

• dijit.layout.ScrollingTabController._getScrollForSelectedTab

  • summary

    Returns the scroll value setting so that the selected tab
    will appear in the center

  • type

    Function

• dijit.layout.ScrollingTabController.createSmoothScroll

  • parameters:
    • x: (typeof Integer)

      An optional pixel value to scroll to, indicating distance from left.

  • returns

    dojo._Animation

  • summary

    Creates a dojo._Animation object that smoothly scrolls the tab list
    either to a fixed horizontal pixel value, or to the selected tab.

  • description

    If an number argument is passed to the function, that horizontal
    pixel position is scrolled to.  Otherwise the currently selected
    tab is scrolled to.

  • type

    Function

• dijit.layout.ScrollingTabController._anim

• dijit.layout.ScrollingTabController._getBtnNode

  • parameters:
    • e: (typeof Event)

      The mouse click event.

  • summary

    Gets a button DOM node from a mouse click event.

  • type

    Function

• dijit.layout.ScrollingTabController.doSlideRight

  • parameters:
    • e: (typeof Event)

      The mouse click event.

  • summary

    Scrolls the menu to the right.

  • type

    Function

• dijit.layout.ScrollingTabController.doSlideLeft

  • parameters:
    • e: (typeof Event)

      The mouse click event.

  • summary

    Scrolls the menu to the left.

  • type

    Function

• dijit.layout.ScrollingTabController.doSlide

  • parameters:
    • direction: (typeof Number)

      If the direction is 1, the widget scrolls to the right, if it is
      -1, it scrolls to the left.

    • node: (typeof DomNode)
  • summary

    Scrolls the tab list to the left or right by 75% of the widget width.

  • type

    Function

• dijit.layout.ScrollingTabController._setButtonClass

  • parameters:
    • scroll: (typeof Number)

      Integer amount of horizontal scroll

  • summary

    Disables the left scroll button if the tabs are scrolled all the way to the left,
    or the right scroll button in the opposite case.

  • type

    Function

• dijit.layout._ScrollingTabControllerButtonMixin

  • type

    Function

• dijit.layout._ScrollingTabControllerButtonMixin.baseClass

  • type

    String

• dijit.layout._ScrollingTabControllerButtonMixin.templateString

  • type

    Object

• dijit.layout._ScrollingTabControllerButtonMixin.tabIndex

  • type

    String

• dijit.layout._ScrollingTabControllerButtonMixin.isFocusable

  • type

    Function

• dijit.layout._ScrollingTabControllerButton

  • type

    Function

  • chains:
    • dijit.form.Button: (prototype)
    • dijit.layout._ScrollingTabControllerButtonMixin.prototype: (prototype)
    • dijit.form.Button: (call)
    • dijit.layout._ScrollingTabControllerButtonMixin: (call)

• dijit.layout._ScrollingTabControllerMenuButton

  • type

    Function

  • chains:
    • dijit.form.Button: (prototype)
    • dijit._HasDropDown.prototype: (prototype)
    • dijit.layout._ScrollingTabControllerButtonMixin.prototype: (prototype)
    • dijit.form.Button: (call)
    • dijit._HasDropDown: (call)
    • dijit.layout._ScrollingTabControllerButtonMixin: (call)

• dijit.layout._ScrollingTabControllerMenuButton.containerId

  • type

    String

• dijit.layout._ScrollingTabControllerMenuButton.tabIndex

  • type

    String

• dijit.layout._ScrollingTabControllerMenuButton.isLoaded

  • type

    Function

• dijit.layout._ScrollingTabControllerMenuButton.loadDropDown

  • parameters:
    • callback
  • type

    Function

• dijit.layout._ScrollingTabControllerMenuButton.dropDown

  • type

    Object

• dijit.layout._ScrollingTabControllerMenuButton.closeDropDown

  • parameters:
    • focus: (typeof Boolean)
  • type

    Function

• dijit.layout

  • type

    Object

• dijit

  • type

    Object