Config Functions
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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Theme configuration syntax reference.
Portions of the theme configuration may be derivations of other values in the config. Rather than calculating these
values manually, several configuration functions are available under the util package. The
util package provides convenience functions that can pre-calculate values in the theme during theme
construction, rather than affecting any runtime performance.
Darkens a given gradient data structure by the scale amount
| Name | Description |
|---|---|
| gradientDetails | The gradient structure to darken |
| scale | A double representing the percentage to darken. For example: 0.2 will make the color 20% darker |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
inactiveGradientDetails = util.darkenGradient(activeGradientDetails, 0.2)
The above example will evaluate to the following:
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
inactiveGradientDetails {
stops = [
"#18457a 0%",
"#206dac 50%",
"#1963a1 51%",
"#6494b9 100%"
]
}
Lightens the gradient data structure by the scale amount. See darkenGradient above for details on how to use it.
Convenience method to create a single-color gradient from the specified color. Returns the gradient data structure.
| Name | Description |
|---|---|
| colorString | Hex color to use to build a solid gradient object |
Convenience method to create a single-color gradient from the specified color. Returns a gradient string, suitable for use in CSS.
| Name | Description |
|---|---|
| colorString | Hex color to use to build a solid gradient string |
Darkens a hex valued color String by scale amount.
| Name | Description |
|---|---|
| colorString | Hex color to darken |
| scale | A double representing the percentage to darken. For example: 0.2 will make the color 20% darker. |
textColor = "#1e5799"
inactiveTextColor = util.darkenColor(textColor, 0.2)
The above example will evaluate to the following:
textColor = "#1e5799"
inactiveTextColor = "#6494b9"
Lightens a hex valued color String by scale amount.
| Name | Description |
|---|---|
| colorString | Hex color to lighten |
| scale | A double representing the percentage to lighten. For example: 0.2 will make the color 20% lighter. |
textColor = "#1e5799"
overTextColor = util.lightenColor(textColor, 0.2)
The above example will evaluate to the following:
textColor = "#1e5799"
overTextColor = "#4b78ad"
Mixes two hex colors with the optional ratio.
| Name | Description | Default value | |
|---|---|---|---|
| color1 | first hex string color to mix | ||
| color2 | second hex string color to mix | ||
| ratio | The ratio of the mix | 0.5 |
red = "#ff0000"
blue = "#0000ff"
eggplant = util.mixColors(red, blue)
lipstick = util.mixColors(red, blue, 0.3)
purple = util.mixColors(red, blue, 0.7)
The above example will evaluate to the following:
red = "#ff0000"
blue = "#0000ff"
eggplant = "#7f007f"
lipstick = "#b2004c"
purple = "#4c00b2"
Converts the gradient data structure into a CSS friendly string.
| Name | Description |
|---|---|
| gradientDetails | The gradient data structure |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
activeGradient = util.gradientString(activeGradientDetails)
The above example will evaluate to the following:
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
activeGradient = "#1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%"
Returns the last stop color of a gradient data structure. Useful if the gradient needs to blend into the background.
| Name | Description |
|---|---|
| gradientDetails | The gradient data structure |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
panelBackgroundColor = util.lastStopColor(activeGradientDetails)
The above example will evaluate to the following:
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
panelBackgroundColor = "#7db9e8"
Converts a color name to its hex representation. Useful when needing to use named colors in styles.
| Name | Description |
|---|---|
| name | name of the color to convert to a hex string |
red = util.colorNameToHex('red')
blue = util.colorNameToHex('blue')
aliceblue = util.colorNameToHex('aliceblue')
The above example will evaluate to the following:
red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"
Converts RGB color values to hex string.
| Name | Description |
|---|---|
| red | red value of the color in the range 0-255 |
| green | green value of the color in the range 0-255 |
| blue | blue value of the color in the range 0-255 |
red = util.rgbToHex(255, 0, 0)
blue = util.rgbToHex(0, 0, 255)
aliceblue = util.rgbToHex(240, 248, 255)
The above example will evaluate to the following:
red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"
Helper function to assign all margin details in one line. All parameters beyond the first are optional, following CSS style for margin values. All values are in pixels.
| Name | Description | Default value | |
|---|---|---|---|
| top | Margin in pixels to apply to the top of the element/widget | ||
| right | Margin in pixels to apply to the right of the element/widget | top |
|
| bottom | Margin in pixels to apply to the bottom of the element/widget | top |
|
| left | Margin in pixels to apply to the left of the element/widget | right |
buttonMargin = util.margin(0, 3, 0, 2)
The above example will evaluate to the following:
buttonMargin {
top = 0
right = 3
bottom = 0
left = 2
}
info {
//...
margin = util.margin(2, 0)
//...
}
The above example would evaluate to
info {
//...
margin {
top = 2
right = 0
bottom = 2
left = 0
}
//...
}
Helper function to assign all padding details in one line. All parameters beyond the first are optional, following CSS style for padding values. All values are in pixels.
| Name | Description | Default value | |
|---|---|---|---|
| top | Padding in pixels to apply to the top of the element/widget | ||
| right | Padding in pixels to apply to the right of the element/widget | top |
|
| bottom | Padding in pixels to apply to the bottom of the element/widget | top |
|
| left | Padding in pixels to apply to the left of the element/widget | right |
Same usage as util.margin
Helper function to assign all border details in one line. All paramters beyond the first are optional, though for visible borders, at least the first three should be specified. Note that not all borders are managed using this border object, as in some cases it is need to require that different details are individually described and managed. Border thickness values are integers, treated as pixels.
| Name | Description | Default value | |
|---|---|---|---|
| style | The style of the border to use, using the legal values for border-style such as none, solid, dashed, etc |
||
| color | The css color of the border to use | "#000000" |
|
| top | The thickness of the top border. | 0 |
|
| right | The thickness of the right border | top |
|
| bottom | The thickness of the bottom border | top |
|
| left | The thickness of the left border | right |
No border:
border = util.border('none')
Solid blue border on all sides:
border = util.border('solid', '#0000ff', 1)
This would evaluate to
border {
style = 'solid'
color = '#0000ff'
top = 1
right = 1
bottom = 1
left = 1
}
Returns the absolute value of the given number
Returns the smaller of the two numbers passed in
Returns the larger of the two numbers passed in
Creates a new object, with all of the values of the first parameter, and overwrites any properties specified in the second parameter.
| Name | Description |
|---|---|
| originalObject | The object to clone and then modify. This is typically a reference to an existing object already declared in the config |
| additionalProperties | Properties that should be overwritten in the newly created object |
dayText = util.fontStyle('helvetica,arial,verdana,sans-serif', '13px', '#000000')
dayDisabledText = util.extend(dayText, {
color = '#808080'
})
This would evaluate to:
dayText {
family = 'helvetica,arial,verdana,sans-serif'
size = '13px'
color = '#000000'
weight = 'normal'
}
dayDisabledText {
family = 'helvetica,arial,verdana,sans-serif'
size = '13px'
color = '#808080'
weight = 'normal'
}
Helper function to declare text styling in a single line. Only the first parameter is required. Unlike most other sizes
that the themer takes, font sizes are treated as a string to support the wide range of possible CSS font-size values.
| Name | Description | Default value | |
|---|---|---|---|
| family | The font family to use. Any valid CSS font-family value is legal here. |
||
| size | The font size to use. Any valid CSS font-size value is legal here. |
"medium" |
|
| color | The text color to use. Any valid CSS color is legal here. | "#000000" |
|
| weight | The font weight to use. Any valid CSS font-weight value is legal here |
"normal" |
Utility method to help reconcile differences in layout between CSS3 and Sliced appearances. In order to keep padding and margin values to be consistently applied, this value lets us make sure that the CSS3 implementation will have the same sizing as the sliced version.
| Name | Description |
|---|---|
| borderObject | a border object, such as what util.border would return |
| radius | an int specifying the border radius on the relevant corners |
Takes a color and an optional scaling value and returns a glossy gradient string.
| Name | Description | Default value | |
|---|---|---|---|
| base | The initial color to start with. | ||
| scale | The optional value to use when stretching the base color into a gradient | 0.15 |
util.glossyGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15
Takes a color and an optional scaling value and returns a bevel gradient string.
| Name | Description | Default value | |
|---|---|---|---|
| base | The initial color to start with. | ||
| scale | The optional value to use when stretching the base color into a gradient | 0.15 |
util.bevelGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15
Takes a color and an optional scaling value and returns a recessed gradient string.
| Name | Description | Default value | |
|---|---|---|---|
| base | The initial color to start with. | ||
| scale | The optional value to use when stretching the base color into a gradient | 0.5 |
util.recessedGradient('#157FCC')
Takes a color and an optional scaling value and returns a matte gradient string.
| Name | Description | Default value | |
|---|---|---|---|
| base | The initial color to start with. | ||
| scale | The optional value to use when stretching the base color into a gradient | 0.04 |
util.matteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.03
Takes a color and an optional scaling value and returns a reversed matte gradient string.
| Name | Description | Default value | |
|---|---|---|---|
| base | The initial color to start with. | ||
| scale | The optional value to use when stretching the base color into a gradient | 0.06 |
util.reversedMatteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.06
GXT | Terms of Use