Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.0.1 - Classic Toolkit


top

Ext.toolbar.Breadcrumb xtype: breadcrumb

Summary

A toolbar that displays hierarchical data from a Ext.data.TreeStore as a trail of breadcrumb buttons. Each button represents a node in the store. A click on a button will "select" that node in the tree. Non-leaf nodes will display their child nodes on a dropdown menu of the corresponding button in the breadcrumb trail, and a click on an item in the menu will trigger selection of the corresponding child node.

The selection can be set programmatically using setSelection, or retrieved using getSelection.

No members found using the current filters

configs

Optional Configs

buttonUI : String
bindable bind

Button UI to use for breadcrumb items. Use extjs-breadcrumb-ui to add special styling to the breadcrumb arrows

Defaults to:

'plain-toolbar'

getButtonUI : String

Returns the value of buttonUI

Returns

String

setButtonUI (buttonUI)

Sets the value of buttonUI

Parameters

buttonUI :  String

displayField : String
bindable bind

The name of the field in the data model to display in the navigation items of this breadcrumb toolbar

Defaults to:

'text'

getDisplayField : String

Returns the value of displayField

Returns

String

setDisplayField (displayField)

Sets the value of displayField

Parameters

displayField :  String

overflowHandler : String
bindable bind

The overflowHandler for this Breadcrumb:

  • null - hidden overflow
  • 'scroller' to render left/right scroller buttons on either side of the breadcrumb
  • 'menu' to render the overflowing buttons as items of an overflow menu.

Defaults to:

null

getOverflowHandler : String

Returns the value of overflowHandler

Returns

String

setOverflowHandler (overflowHandler)

Sets the value of overflowHandler

Parameters

overflowHandler :  String

selection : Ext.data.TreeModel / String
bindable bind

The selected node, or "root" to select the root node

Defaults to:

'root'

getSelection Ext.data.TreeModel

Returns the currently selected Ext.data.TreeModel.

Returns

:Ext.data.TreeModel

node The selected node (or null if there is no selection).

setSelection ( node ) : Ext.toolbar.Breadcrumb

Selects the passed Ext.data.TreeModel in the breadcrumb component.

Parameters

node :  Ext.data.TreeModel

The node in the breadcrumb store to select as the active node.

Returns

:Ext.toolbar.Breadcrumb

this The breadcrumb component

showIcons : Boolean
bindable bind

Controls whether or not icons of tree nodes are displayed in the breadcrumb buttons. There are 3 possible values for this config:

  1. unspecified (null) - the default value. In this mode only icons that are specified in the tree data using (icon or iconCls will be displayed, but the default "folder" and "leaf" icons will not be displayed.

  2. true - Icons specified in the tree data will be displayed, and the default "folder" and "leaf" icons will be displayed for nodes that do not specify an icon or iconCls.

  3. false - No icons will be displayed in the breadcrumb buttons, only text.

Defaults to:

null

getShowIcons : Boolean

Returns the value of showIcons

Returns

Boolean

setShowIcons (showIcons)

Sets the value of showIcons

Parameters

showIcons :  Boolean

showMenuIcons : Boolean
bindable bind

Controls whether or not icons of tree nodes are displayed in the breadcrumb menu items. There are 3 possible values for this config:

  1. unspecified (null) - the default value. In this mode only icons that are specified in the tree data using (icon or iconCls will be displayed, but the default "folder" and "leaf" icons will not be displayed.

  2. true - Icons specified in the tree data will be displayed, and the default "folder" and "leaf" icons will be displayed for nodes that do not specify an icon or iconCls.

  3. false - No icons will be displayed on the breadcrumb menu items, only text.

Defaults to:

null

getShowMenuIcons : Boolean

Returns the value of showMenuIcons

Returns

Boolean

setShowMenuIcons (showMenuIcons)

Sets the value of showMenuIcons

Parameters

showMenuIcons :  Boolean

store : Ext.data.TreeStore
bindable bind

The TreeStore that this breadcrumb toolbar should use as its data source

Defaults to:

null

getStore : Ext.data.TreeStore

Returns the value of store

Returns

Ext.data.TreeStore

setStore (store)

Sets the value of store

Parameters

store :  Ext.data.TreeStore

useSplitButtons : Boolean
bindable bind

false to use regular Ext.button.Buttons instead of Ext.button.Split. When true, a click on the body of a button will navigate to the specified node, and a click on the arrow will show a menu containing the the child nodes. When false, the only mode of navigation is the menu, since a click anywhere on the button will show the menu.

Defaults to:

true

getUseSplitButtons : Boolean

Returns the value of useSplitButtons

Returns

Boolean

setUseSplitButtons (useSplitButtons)

Sets the value of useSplitButtons

Parameters

useSplitButtons :  Boolean

properties

Instance Properties

buttons : Ext.button.Split[]
private pri

Internal cache of buttons that are re-purposed as the items of this container as navigation occurs.

Defaults to:

[]

methods

Instance Methods

_onButtonClick ( button, e )
private pri

Handles a click on a breadcrumb button

Parameters

button :  Ext.button.Split

e :  Ext.event.Event

_onMenuBeforeShow ( menu ) : Boolean
private pri

Handles the beforeshow event of a button menu

Parameters

menu :  Ext.menu.Menu

Returns

:Boolean

_onMenuClick ( menu, item, e )
private pri

Handles a click on a button menu

Parameters

menu :  Ext.menu.Menu

item :  Ext.menu.Item

e :  Ext.event.Event

events

change ( this, node, prevNode, eOpts )

Fires when the user changes the selected record. In contrast to the selectionchange event, this does not fire at render time, only in response to user activity.

Parameters

this :  Ext.toolbar.Breadcrumb

node :  Ext.data.TreeModel

The selected node.

prevNode :  Ext.data.TreeModel

The previously selected node.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

selectionchange ( this, node, prevNode, eOpts )

Fires when the selected node changes. At render time, this event will fire indicating that the configured selection has been selected.

Parameters

this :  Ext.toolbar.Breadcrumb

node :  Ext.data.TreeModel

The selected node.

prevNode :  Ext.data.TreeModel

The previously selected node.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$breadcrumb-arrow-expanded-glyph : String / list

Glyph for the "expanded arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$fa-var-angle-down $breadcrumb-glyph-font-size $font-icon-font-family

$breadcrumb-arrow-expanded-glyph-color : color

The color to use for the "expanded arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$breadcrumb-arrow-glyph-color

$breadcrumb-arrow-glyph : String / list

Glyph for the "arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$fa-var-angle-right $breadcrumb-glyph-font-size $font-icon-font-family

$breadcrumb-arrow-glyph-color : color

The color to use for the "arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$breadcrumb-glyph-color

$breadcrumb-arrow-width : Number

The width of breadcrumb arrows when useSplitButtons is false

Defaults to:

$button-small-split-width

$breadcrumb-button-spacing : Number

The space between the breadcrumb buttons

Defaults to:

0px

$breadcrumb-button-ui : String

The UI of buttons that are used in the "default" breadcrumb UI

Defaults to:

'default-toolbar'

$breadcrumb-classic-scrollers : Boolean

true to use classic-style scroller buttons. When true scroller buttons are given their hover state by changing their background-position, When false scroller buttons are given their hover state by applying opacity.

Defaults to:

$toolbar-classic-scrollers

$breadcrumb-folder-glyph : String / list

Glyph for the "folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$fa-var-folder-o $breadcrumb-glyph-font-size $font-icon-font-family

$breadcrumb-folder-glyph-color : color

The color to use for the "folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$breadcrumb-glyph-color

$breadcrumb-folder-icon : String

The background-image for the default "folder" icon

Defaults to:

'tree/folder'

$breadcrumb-folder-open-glyph : String / list

Glyph for the "open folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$fa-var-folder-open-o $breadcrumb-glyph-font-size $font-icon-font-family

$breadcrumb-folder-open-glyph-color : color

The color to use for the "open folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$breadcrumb-folder-glyph-color

$breadcrumb-folder-open-icon : String

The background-image for the default "open folder" icon

Defaults to:

'tree/folder-open'

$breadcrumb-glyph-color : color

The color to use for breadcrumb icons when Global_CSS#$enable-font-icons is true.

Defaults to:

$button-toolbar-glyph-color

$breadcrumb-glyph-font-size : Number

The font size to use for breadcrumb icons when Global_CSS#$enable-font-icons is true.

Defaults to:

16px

$breadcrumb-include-menu-active-arrow : Boolean

true to include a separate background-image for menu arrows when a breadcrumb button's menu is open

Defaults to:

true

$breadcrumb-include-split-over-arrow : Boolean

true to include a separate background-image for split arrows when a breadcrumb button's arrow is hovered

Defaults to:

true

$breadcrumb-leaf-glyph : String / list

Glyph for the "leaf" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$fa-var-file-o $breadcrumb-glyph-font-size $font-icon-font-family

$breadcrumb-leaf-glyph-color : color

The color to use for the "leaf" icon when Global_CSS#$enable-font-icons is true.

Defaults to:

$breadcrumb-glyph-color

$breadcrumb-leaf-icon : String

The background-image for the default "leaf" icon

Defaults to:

'tree/leaf'

$breadcrumb-scroller-border-color : color

The border-color of Breadcrumb scrollers

Defaults to:

$toolbar-scroller-border-color

$breadcrumb-scroller-border-width : Number

The border-width of Breadcrumb scrollers

Defaults to:

$toolbar-scroller-border-width

$breadcrumb-scroller-bottom-margin : Number / list

The margin of "bottom" Breadcrumb scroller buttons

Defaults to:

$toolbar-scroller-bottom-margin

$breadcrumb-scroller-cursor : String

The cursor of Breadcrumb scrollers

Defaults to:

$toolbar-scroller-cursor

$breadcrumb-scroller-cursor-disabled : String

The cursor of disabled Breadcrumb scrollers

Defaults to:

$toolbar-scroller-cursor-disabled

$breadcrumb-scroller-height : Number

The height of Breadcrumb scrollers

Defaults to:

$toolbar-scroller-height

$breadcrumb-scroller-left-margin : Number / list

The margin of "left" Breadcrumb scroller buttons

Defaults to:

$toolbar-scroller-left-margin

$breadcrumb-scroller-opacity : Number

The opacity of Breadcrumb scroller buttons. Only applicable when $breadcrumb-classic-scrollers is false.

Defaults to:

$toolbar-scroller-opacity

$breadcrumb-scroller-opacity-disabled : Number

The opacity of disabled Breadcrumb scroller buttons. Only applicable when $breadcrumb-classic-scrollers is false.

Defaults to:

$toolbar-scroller-opacity-disabled

$breadcrumb-scroller-opacity-over : Number

The opacity of hovered Breadcrumb scroller buttons. Only applicable when $breadcrumb-classic-scrollers is false.

Defaults to:

$toolbar-scroller-opacity-over

$breadcrumb-scroller-opacity-pressed : Number

The opacity of pressed Breadcrumb scroller buttons. Only applicable when $breadcrumb-classic-scrollers is false.

Defaults to:

$toolbar-scroller-opacity-pressed

$breadcrumb-scroller-right-margin : Number / list

The margin of "right" Breadcrumb scroller buttons

Defaults to:

$toolbar-scroller-right-margin

$breadcrumb-scroller-top-margin : Number / list

The margin of "top" Breadcrumb scroller buttons

Defaults to:

$toolbar-scroller-top-margin

$breadcrumb-scroller-width : Number

The width of Breadcrumb scrollers

Defaults to:

$toolbar-scroller-width

$breadcrumb-split-width : Number

The width of breadcrumb arrows when useSplitButtons is true

Defaults to:

$button-small-split-width

$include-breadcrumb-default-ui : Boolean

true to include the "default" breadcrumb UI

Defaults to:

true

theme mixins

extjs-breadcrumb-ui ( ...list... )

Creates a visual theme for a Breadcrumb.

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$ui-button-ui :  String (optional)

The name of the button UI that will be used with this breadcrumb UI. Used for overriding the button arrows for the given button UI when it is used inside a breadcrumb with this UI.

Defaults to: $breadcrumb-button-ui

$ui-button-spacing :  Number (optional)

The space between the breadcrumb buttons

Defaults to: $breadcrumb-button-spacing

$ui-arrow-width :  Number (optional)

The width of the breadcrumb arrows when Ext.toolbar.Breadcrumb#useSplitButtons is false

Defaults to: $breadcrumb-arrow-width

$ui-split-width :  Number (optional)

The width of breadcrumb arrows when Ext.toolbar.Breadcrumb#useSplitButtons is true

Defaults to: $breadcrumb-split-width

$ui-include-menu-active-arrow :  Boolean (optional)

true to include a separate background-image for menu arrows when a breadcrumb button's menu is open

Defaults to: $breadcrumb-include-menu-active-arrow

$ui-include-split-over-arrow :  Boolean (optional)

true to include a separate background-image for split arrows when a breadcrumb button's arrow is hovered

Defaults to: $breadcrumb-include-split-over-arrow

$ui-folder-icon :  String (optional)

The background-image for the "folder" icon

Defaults to: $breadcrumb-folder-icon

$ui-folder-open-icon :  String (optional)

The background-image for the "open folder" icon

Defaults to: $breadcrumb-folder-open-icon

$ui-leaf-icon :  String (optional)

The background-image for the "leaf" icon

Defaults to: $breadcrumb-leaf-icon

$ui-folder-glyph :  String/list (optional)

Glyph for the "folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-folder-glyph

$ui-folder-glyph-color :  color (optional)

The color to use for the "folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-folder-glyph-color

$ui-folder-open-glyph :  String/list (optional)

Glyph for the "open folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-folder-open-glyph

$ui-folder-open-glyph-color :  color (optional)

The color to use for the "open folder" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-folder-open-glyph-color

$ui-leaf-glyph :  String/list (optional)

Glyph for the "leaf" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-leaf-glyph

$ui-leaf-glyph-color :  color (optional)

The color to use for the "leaf" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-leaf-glyph-color

$ui-arrow-glyph :  String/list (optional)

Glyph for the "arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-arrow-glyph

$ui-arrow-glyph-color :  color (optional)

The color to use for the "arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-arrow-glyph-color

$ui-arrow-expanded-glyph :  String/list (optional)

Glyph for the "expanded arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-arrow-expanded-glyph

$ui-arrow-expanded-glyph-color :  color (optional)

The color to use for the "expanded arrow" icon when Global_CSS#$enable-font-icons is true.

Defaults to: $breadcrumb-arrow-expanded-glyph-color

$ui-scroller-width :  Number (optional)

The width of Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-width

$ui-scroller-height :  Number (optional)

The height of Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-height

$ui-scroller-border-color :  color (optional)

The border-color of Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-border-color

$ui-scroller-border-width :  Number (optional)

The border-width of Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-border-width

$ui-scroller-top-margin :  Number/list (optional)

The margin of "top" scroller buttons

Defaults to: $breadcrumb-scroller-top-margin

$ui-scroller-right-margin :  Number/list (optional)

The margin of "right" scroller buttons

Defaults to: $breadcrumb-scroller-right-margin

$ui-scroller-bottom-margin :  Number/list (optional)

The margin of "bottom" scroller buttons

Defaults to: $breadcrumb-scroller-bottom-margin

$ui-scroller-left-margin :  Number/list (optional)

The margin of "left" scroller buttons

Defaults to: $breadcrumb-scroller-left-margin

$ui-scroller-cursor :  String (optional)

The cursor of Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-cursor

$ui-scroller-cursor-disabled :  String (optional)

The cursor of disabled Breadcrumb scrollers

Defaults to: $breadcrumb-scroller-cursor-disabled

$ui-scroller-opacity :  Number (optional)

The opacity of Breadcrumb scroller buttons. Only applicable when $ui-classic-scrollers is false.

Defaults to: $breadcrumb-scroller-opacity

$ui-scroller-opacity-over :  Number (optional)

The opacity of hovered Breadcrumb scroller buttons. Only applicable when $ui-classic-scrollers is false.

Defaults to: $breadcrumb-scroller-opacity-over

$ui-scroller-opacity-pressed :  Number (optional)

The opacity of pressed Breadcrumb scroller buttons. Only applicable when $ui-classic-scrollers is false.

Defaults to: $breadcrumb-scroller-opacity-pressed

$ui-scroller-opacity-disabled :  Number (optional)

The opacity of disabled Breadcrumb scroller buttons.

Defaults to: $breadcrumb-scroller-opacity-disabled

$ui-classic-scrollers :  Boolean (optional)

true to use classic-style scroller buttons. When true scroller buttons are given their hover state by changing their background-position, When false scroller buttons are given their hover state by applying opacity.

Defaults to: $breadcrumb-classic-scrollers

Ext JS 6.0.1 - Classic Toolkit