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

More...

Inheritance diagram for Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >:
Ext.Net.AbstractPanel.Builder< TAbstractWindow, TBuilder >

Public Member Functions

 Builder (TAbstractWindow component)
 
virtual TBuilder AnimateTarget (string animateTarget)
 Id or element from which the window should animate while opening (defaults to null with no animation). More...
 
virtual TBuilder CloseAction (CloseAction closeAction)
 The action to take when the close button is clicked. The default action is 'close' which will actually remove the window from the DOM and destroy it. The other valid option is 'hide' which will simply hide the window by setting visibility to hidden and applying negative offsets, keeping the window available to be redisplayed via the show method. More...
 
virtual TBuilder ConstrainHeader (bool constrainHeader)
 True to constrain the window header within its containing element (allowing the window body to fall outside of its containing element) or false to allow the header to fall outside its containing element (defaults to false). Optionally the entire window can be constrained using constrain. More...
 
virtual TBuilder DefaultFocus (string defaultFocus)
 The id of a button to focus when this window received the focus. More...
 
virtual TBuilder DefaultRenderTo (DefaultRenderTo defaultRenderTo)
 The default render to Element (Body or Form). Using when AutoRender="false" or when the Window is a lazy item (i.e. defined in a container's items). More...
 
virtual TBuilder ExpandOnShow (bool expandOnShow)
 True to always expand the window when it is displayed, false to keep it in its current state (which may be collapsed) when displayed (defaults to true). More...
 
virtual TBuilder HideMode (HideMode hideMode)
 A String which specifies how this AbstractComponent's encapsulating DOM element will be hidden. More...
 
virtual TBuilder MaskClickAction (ClickableAction maskClickAction)
 The method to call when the window's modal mask is clicked or tapped. More...
 
virtual TBuilder Maximizable (bool? maximizable)
 True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button and disallow maximizing the window (defaults to false). Note that when a window is maximized, the tool button will automatically change to a 'restore' button with the appropriate behavior already built-in that will restore the window to its previous size. More...
 
virtual TBuilder Maximized (bool maximized)
 True to initially display the window in a maximized state. (Defaults to false). More...
 
virtual TBuilder Minimizable (bool? minimizable)
 True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button and disallow minimizing the window (defaults to false). Note that this button provides no implementation – the behavior of minimizing a window is implementation-specific, so the minimize event must be handled and a custom minimize behavior implemented for this option to be useful. More...
 
virtual TBuilder Modal (bool modal)
 True to make the window modal and mask everything behind it when displayed, false to display it without restricting access to other UI elements (defaults to false). More...
 
virtual TBuilder OnEsc (string onEsc)
 Allows override of the built-in processing for the escape key. Default action is to close the Window (performing whatever action is specified in closeAction. To prevent the Window closing when the escape key is pressed, specify this as Ext.emptyFn (See Ext.emptyFn). More...
 
virtual TBuilder Plain (bool plain)
 True to render the window body with a transparent background so that it will blend into the framing elements, false to add a lighter background color to visually highlight the body element and separate it more distinctly from the surrounding frame (defaults to false). More...
 
virtual TBuilder Ghost (bool ghost)
 Set to false to disable the ghost panel during dragging the window. More...
 
virtual TBuilder AutoRender (bool autoRender)
 This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false. More...
 
virtual TBuilder Hide (Control animateTarget)
 Hides the window, setting it to invisible and applying negative offsets. More...
 
virtual TBuilder Hide (Control animateTarget, string callback)
 Hides the window, setting it to invisible and applying negative offsets. More...
 
virtual TBuilder Hide (Control animateTarget, string callback, string scope)
 Hides the window, setting it to invisible and applying negative offsets. More...
 
virtual TBuilder Hide (string animateTarget, string callback, string scope)
 Hides the window, setting it to invisible and applying negative offsets. More...
 
virtual TBuilder Maximize ()
 Fits the window within its current container and automatically replaces the 'maximize' tool button with the 'restore' tool button. More...
 
virtual TBuilder Minimize ()
 Placeholder method for minimizing the window. By default, this method simply fires the minimize event since the behavior of minimizing a window is application-specific. To implement custom minimize behavior, either the minimize event can be handled or this method can be overridden. More...
 
virtual TBuilder Restore ()
 Restores a maximized window back to its original size and position prior to being maximized and also replaces the 'restore' tool button with the 'maximize' tool button. More...
 
virtual TBuilder SetAnimateTarget (string element)
 Sets the target element from which the window should animate while opening. More...
 
virtual TBuilder SetAnimateTarget (Control element)
 Sets the target element from which the window should animate while opening. More...
 
virtual TBuilder ToggleMaximize ()
 A shortcut method for toggling between maximize and restore based on the current maximized state of the window. More...
 

Detailed Description

Type Constraints
TAbstractWindow :AbstractWindow 
TBuilder :Builder 
TBuilder :TAbstractWindow 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Builder ( TAbstractWindow  component)
inline

Member Function Documentation

◆ AnimateTarget()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.AnimateTarget ( string  animateTarget)
inlinevirtual

Id or element from which the window should animate while opening (defaults to null with no animation).

◆ AutoRender()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.AutoRender ( bool  autoRender)
inlinevirtual

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false.

◆ CloseAction()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.CloseAction ( CloseAction  closeAction)
inlinevirtual

The action to take when the close button is clicked. The default action is 'close' which will actually remove the window from the DOM and destroy it. The other valid option is 'hide' which will simply hide the window by setting visibility to hidden and applying negative offsets, keeping the window available to be redisplayed via the show method.

◆ ConstrainHeader()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.ConstrainHeader ( bool  constrainHeader)
inlinevirtual

True to constrain the window header within its containing element (allowing the window body to fall outside of its containing element) or false to allow the header to fall outside its containing element (defaults to false). Optionally the entire window can be constrained using constrain.

◆ DefaultFocus()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.DefaultFocus ( string  defaultFocus)
inlinevirtual

The id of a button to focus when this window received the focus.

◆ DefaultRenderTo()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.DefaultRenderTo ( DefaultRenderTo  defaultRenderTo)
inlinevirtual

The default render to Element (Body or Form). Using when AutoRender="false" or when the Window is a lazy item (i.e. defined in a container's items).

◆ ExpandOnShow()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.ExpandOnShow ( bool  expandOnShow)
inlinevirtual

True to always expand the window when it is displayed, false to keep it in its current state (which may be collapsed) when displayed (defaults to true).

◆ Ghost()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Ghost ( bool  ghost)
inlinevirtual

Set to false to disable the ghost panel during dragging the window.

◆ Hide() [1/4]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Hide ( Control  animateTarget)
inlinevirtual

Hides the window, setting it to invisible and applying negative offsets.

◆ Hide() [2/4]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Hide ( Control  animateTarget,
string  callback 
)
inlinevirtual

Hides the window, setting it to invisible and applying negative offsets.

◆ Hide() [3/4]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Hide ( Control  animateTarget,
string  callback,
string  scope 
)
inlinevirtual

Hides the window, setting it to invisible and applying negative offsets.

◆ Hide() [4/4]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Hide ( string  animateTarget,
string  callback,
string  scope 
)
inlinevirtual

Hides the window, setting it to invisible and applying negative offsets.

◆ HideMode()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.HideMode ( HideMode  hideMode)
inlinevirtual

A String which specifies how this AbstractComponent's encapsulating DOM element will be hidden.

◆ MaskClickAction()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.MaskClickAction ( ClickableAction  maskClickAction)
inlinevirtual

The method to call when the window's modal mask is clicked or tapped.

◆ Maximizable()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Maximizable ( bool?  maximizable)
inlinevirtual

True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button and disallow maximizing the window (defaults to false). Note that when a window is maximized, the tool button will automatically change to a 'restore' button with the appropriate behavior already built-in that will restore the window to its previous size.

◆ Maximize()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Maximize ( )
inlinevirtual

Fits the window within its current container and automatically replaces the 'maximize' tool button with the 'restore' tool button.

◆ Maximized()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Maximized ( bool  maximized)
inlinevirtual

True to initially display the window in a maximized state. (Defaults to false).

◆ Minimizable()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Minimizable ( bool?  minimizable)
inlinevirtual

True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button and disallow minimizing the window (defaults to false). Note that this button provides no implementation – the behavior of minimizing a window is implementation-specific, so the minimize event must be handled and a custom minimize behavior implemented for this option to be useful.

◆ Minimize()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Minimize ( )
inlinevirtual

Placeholder method for minimizing the window. By default, this method simply fires the minimize event since the behavior of minimizing a window is application-specific. To implement custom minimize behavior, either the minimize event can be handled or this method can be overridden.

◆ Modal()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Modal ( bool  modal)
inlinevirtual

True to make the window modal and mask everything behind it when displayed, false to display it without restricting access to other UI elements (defaults to false).

◆ OnEsc()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.OnEsc ( string  onEsc)
inlinevirtual

Allows override of the built-in processing for the escape key. Default action is to close the Window (performing whatever action is specified in closeAction. To prevent the Window closing when the escape key is pressed, specify this as Ext.emptyFn (See Ext.emptyFn).

◆ Plain()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Plain ( bool  plain)
inlinevirtual

True to render the window body with a transparent background so that it will blend into the framing elements, false to add a lighter background color to visually highlight the body element and separate it more distinctly from the surrounding frame (defaults to false).

◆ Restore()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.Restore ( )
inlinevirtual

Restores a maximized window back to its original size and position prior to being maximized and also replaces the 'restore' tool button with the 'maximize' tool button.

◆ SetAnimateTarget() [1/2]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.SetAnimateTarget ( Control  element)
inlinevirtual

Sets the target element from which the window should animate while opening.

◆ SetAnimateTarget() [2/2]

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.SetAnimateTarget ( string  element)
inlinevirtual

Sets the target element from which the window should animate while opening.

◆ ToggleMaximize()

virtual TBuilder Ext.Net.AbstractWindow.Builder< TAbstractWindow, TBuilder >.ToggleMaximize ( )
inlinevirtual

A shortcut method for toggling between maximize and restore based on the current maximized state of the window.


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