Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.StatusBar.Builder< TStatusBar, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >:
Ext.Net.ToolbarBase.Builder< TStatusBar, TBuilder >

Public Member Functions

 Builder (TStatusBar component)
 
virtual TBuilder AutoClear (int autoClear)
 The number of milliseconds to wait after setting the status via setStatus before automatically clearing the status text and icon (defaults to 5000). Note that this only applies when passing the clear argument to setStatus since that is the only way to defer clearing the status. This can be overridden by specifying a different wait value in setStatus. Calls to clearStatus always clear the status bar immediately and ignore this value. More...
 
virtual TBuilder BusyIcon (Icon busyIcon)
 The default Icon applied when calling showBusy (defaults to 'Icon.None'). It can be overridden at any time by passing the iconCls argument into showBusy. See the Icon or IconCls docs for additional details about customizing the icon. More...
 
virtual TBuilder BusyIconCls (string busyIconCls)
 The default iconCls applied when calling showBusy (defaults to 'x-status-busy'). It can be overridden at any time by passing the iconCls argument into showBusy. See the iconCls docs for additional details about customizing the icon. More...
 
virtual TBuilder BusyText (string busyText)
 The default text applied when calling showBusy (defaults to 'Loading...'). It can be overridden at any time by passing the text argument into showBusy. More...
 
virtual TBuilder DefaultIcon (Icon defaultIcon)
 The default Icon (see the Icon or IconCls docs for additional details about customizing the icon). This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to 'Icon.None'). More...
 
virtual TBuilder DefaultIconCls (string defaultIconCls)
 The default iconCls value (see the iconCls docs for additional details about customizing the icon). This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to ''). More...
 
virtual TBuilder DefaultText (string defaultText)
 The default text value. This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to ''). More...
 
virtual TBuilder Icon (Icon icon)
 An Icon that will be applied to the status element and is expected to provide a background image that will serve as the status bar icon (defaults to 'Icon.None'). The Icons is applied directly to the div that also contains the status text, so the rule should provide the appropriate padding on the div to make room for the image. More...
 
virtual TBuilder IconCls (string iconCls)
 A CSS class that will be applied to the status element and is expected to provide a background image that will serve as the status bar icon (defaults to ''). The class is applied directly to the div that also contains the status text, so the rule should provide the appropriate padding on the div to make room for the image. More...
 
virtual TBuilder StatusAlign (StatusAlign statusAlign)
 The alignment of the status element within the overall StatusBar layout. When the StatusBar is rendered, it creates an internal div containing the status text and icon. Any additional Toolbar items added in the StatusBar's items config, or added via add or any of the supported add* methods, will be rendered, in added order, to the opposite side. The status element is greedy, so it will automatically expand to take up all sapce left over by any other items. More...
 
virtual TBuilder Text (string text)
 A string that will be rendered into the status element as the status message (defaults to ''). More...
 
virtual TBuilder Listeners (Action< ToolbarListeners > action)
 Client-side JavaScript Event Handlers More...
 
virtual TBuilder DirectEvents (Action< StatusBarDirectEvents > action)
 Server-side Ajax Event Handlers More...
 
virtual TBuilder ClearStatus ()
 Clears the status text and iconCls. Also supports clearing via an optional fade out animation. More...
 
virtual TBuilder ClearStatus (StatusBarClearStatusConfig config)
 Clears the status text and iconCls. Also supports clearing via an optional fade out animation. More...
 
virtual TBuilder SetStatus (string text)
 Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified interval. More...
 
virtual TBuilder SetStatus (StatusBarStatusConfig config)
 Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified interval. More...
 
virtual TBuilder ShowBusy (string text)
 Convenience method for setting the status text and icon to special values that are pre-configured to indicate a 'busy' state, usually for loading or processing activities. More...
 
 Builder ()
 
 Builder (StatusBar component)
 
 Builder (StatusBar.Config config)
 
- Public Member Functions inherited from Ext.Net.ToolbarBase.Builder< TStatusBar, TBuilder >
 Builder (TToolbarBase component)
 
virtual TBuilder DefaultButtonUI (string defaultButtonUI)
 
virtual TBuilder DefaultFieldUI (string defaultFieldUI)
 
virtual TBuilder DefaultFooterButtonUI (string defaultFooterButtonUI)
 
virtual TBuilder DefaultFooterFieldUI (string defaultFooterFieldUI)
 
virtual TBuilder DefaultType (string defaultType)
 The default type of content Container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel'). More...
 
virtual TBuilder Flat (bool flat)
 True to use flat style. More...
 
virtual TBuilder ClassicButtonStyle (bool classicButtonStyle)
 True to use classic (none-flat) style. More...
 
virtual TBuilder EnableOverflow (bool enableOverflow)
 Configure true to make the toolbar provide a button which activates a dropdown Menu to show items which overflow the Toolbar's width. More...
 
virtual TBuilder OverflowHandler (OverflowHandler overflowHandler)
 
virtual TBuilder TrackMenus (bool? trackMenus)
 By default, when a toolbar button has a menu open, then mouseing over other toolbar buttons opens their menus. More...
 
virtual TBuilder Vertical (bool vertical)
 Set to true to make the toolbar vertical. The layout will become a vbox. Defaults to: false More...
 

Static Public Member Functions

static implicit operator Builder (StatusBar component)
 

Detailed Description

Type Constraints
TStatusBar :StatusBar 
TBuilder :Builder 
TBuilder :TStatusBar 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Builder ( TStatusBar  component)
inline

◆ Builder() [2/4]

Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Builder ( StatusBar  component)
inline

◆ Builder() [4/4]

Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Builder ( StatusBar.Config  config)
inline

Member Function Documentation

◆ AutoClear()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.AutoClear ( int  autoClear)
inlinevirtual

The number of milliseconds to wait after setting the status via setStatus before automatically clearing the status text and icon (defaults to 5000). Note that this only applies when passing the clear argument to setStatus since that is the only way to defer clearing the status. This can be overridden by specifying a different wait value in setStatus. Calls to clearStatus always clear the status bar immediately and ignore this value.

◆ BusyIcon()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.BusyIcon ( Icon  busyIcon)
inlinevirtual

The default Icon applied when calling showBusy (defaults to 'Icon.None'). It can be overridden at any time by passing the iconCls argument into showBusy. See the Icon or IconCls docs for additional details about customizing the icon.

◆ BusyIconCls()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.BusyIconCls ( string  busyIconCls)
inlinevirtual

The default iconCls applied when calling showBusy (defaults to 'x-status-busy'). It can be overridden at any time by passing the iconCls argument into showBusy. See the iconCls docs for additional details about customizing the icon.

◆ BusyText()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.BusyText ( string  busyText)
inlinevirtual

The default text applied when calling showBusy (defaults to 'Loading...'). It can be overridden at any time by passing the text argument into showBusy.

◆ ClearStatus() [1/2]

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.ClearStatus ( )
inlinevirtual

Clears the status text and iconCls. Also supports clearing via an optional fade out animation.

◆ ClearStatus() [2/2]

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.ClearStatus ( StatusBarClearStatusConfig  config)
inlinevirtual

Clears the status text and iconCls. Also supports clearing via an optional fade out animation.

◆ DefaultIcon()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.DefaultIcon ( Icon  defaultIcon)
inlinevirtual

The default Icon (see the Icon or IconCls docs for additional details about customizing the icon). This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to 'Icon.None').

◆ DefaultIconCls()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.DefaultIconCls ( string  defaultIconCls)
inlinevirtual

The default iconCls value (see the iconCls docs for additional details about customizing the icon). This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to '').

◆ DefaultText()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.DefaultText ( string  defaultText)
inlinevirtual

The default text value. This will be used anytime the status bar is cleared with the useDefaults:true option (defaults to '').

◆ DirectEvents()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.DirectEvents ( Action< StatusBarDirectEvents action)
inlinevirtual

Server-side Ajax Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Icon()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Icon ( Icon  icon)
inlinevirtual

An Icon that will be applied to the status element and is expected to provide a background image that will serve as the status bar icon (defaults to 'Icon.None'). The Icons is applied directly to the div that also contains the status text, so the rule should provide the appropriate padding on the div to make room for the image.

◆ IconCls()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.IconCls ( string  iconCls)
inlinevirtual

A CSS class that will be applied to the status element and is expected to provide a background image that will serve as the status bar icon (defaults to ''). The class is applied directly to the div that also contains the status text, so the rule should provide the appropriate padding on the div to make room for the image.

◆ Listeners()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Listeners ( Action< ToolbarListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ operator Builder()

static implicit Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.operator Builder ( StatusBar  component)
inlinestatic

◆ SetStatus() [1/2]

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.SetStatus ( StatusBarStatusConfig  config)
inlinevirtual

Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified interval.

◆ SetStatus() [2/2]

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.SetStatus ( string  text)
inlinevirtual

Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified interval.

◆ ShowBusy()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.ShowBusy ( string  text)
inlinevirtual

Convenience method for setting the status text and icon to special values that are pre-configured to indicate a 'busy' state, usually for loading or processing activities.

◆ StatusAlign()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.StatusAlign ( StatusAlign  statusAlign)
inlinevirtual

The alignment of the status element within the overall StatusBar layout. When the StatusBar is rendered, it creates an internal div containing the status text and icon. Any additional Toolbar items added in the StatusBar's items config, or added via add or any of the supported add* methods, will be rendered, in added order, to the opposite side. The status element is greedy, so it will automatically expand to take up all sapce left over by any other items.

◆ Text()

virtual TBuilder Ext.Net.StatusBar.Builder< TStatusBar, TBuilder >.Text ( string  text)
inlinevirtual

A string that will be rendered into the status element as the status message (defaults to '').


The documentation for this class was generated from the following file: