Class type Ext_window_Window.configs

class type configs = object .. end

Inherits

Ext_panel_Panel.configs

method animateTarget : 'a. 'a Js.t Js.prop

Id or element from which the window should animate while opening.

Defaults to: null

method autoRender : 'b. 'b Js.t Js.prop

Windows render to the body on first show.

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show. If floating is true, the value of this config is omitted as if it is true.

Specify as true to have this Component render to the document body upon first show.

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

Defaults to: true

method baseCls : Js.js_string Js.t Js.prop

The base CSS class to apply to this panel's element.

Defaults to: 'x-window'

method closable : bool Js.t Js.prop

True to display the 'close' tool button and allow the user to close the window, false to hide the button and disallow closing the window.

By default, when close is requested by either clicking the close button in the header or pressing ESC when the Window has focus, the close method will be called. This will destroy the Window and its content meaning that it may not be reused.

To make closing a Window hide the Window so that it may be reused, set closeAction to 'hide'.

Defaults to: true

method collapsed : bool Js.t Js.prop

True to render the window collapsed, false to render it expanded. Note that if expandOnShow is true (the default) it will override the collapsed config and the window will always be expanded when shown.

Defaults to: false

method collapsible : bool Js.t Js.prop

inherited docs, same default

True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool. When a panel is used in a border layout, the floatable option can influence the behavior of collapsing. See collapseMode and collapseDirection

Defaults to: false

method constrain : bool Js.t Js.prop

True to constrain the window within its containing element, false to allow it to fall outside of its containing element. By default the window will be rendered to document.body. To render and constrain the window within another element specify renderTo. Optionally the header only can be constrained using constrainHeader.

Defaults to: false

method constrainHeader : bool Js.t Js.prop

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. Optionally the entire window can be constrained using constrain.

Defaults to: false

method defaultFocus : 'c. 'c Js.t Js.prop

Specifies a Component to receive focus when this Window is focused.

This may be one of:

The index of a footer Button.
The id or Ext.AbstractComponent.itemId of a descendant Component.
A Component.

method draggable : bool Js.t Js.prop

True to allow the window to be dragged by the header bar, false to disable dragging. Note that by default the window will be centered in the viewport, so if dragging is disabled the window may need to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);).

Defaults to: true

method expandOnShow : bool Js.t Js.prop

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

method ghost : 'd. 'd Js.t Js.prop

Set to false to disable the ghost panel during dragging the window. Do note that you should not set this to true, by default it is a function.

method hidden : bool Js.t Js.prop

Render this Window hidden. If true, the hide method will be called internally.

Defaults to: true

method hideMode : Js.js_string Js.t Js.prop

Windows hide using offsets in order to preserve the scroll positions of their descendants.

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:

'display' : The Component will be hidden using the display: none style.
'visibility' : The Component will be hidden using the visibility: hidden style.
'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to: 'offsets'

method hideShadowOnDeactivate : bool Js.t Js.prop

True to hide this Window's shadow when another floating item in the same z-index stack is activated.

Defaults to: false

method maximizable : bool Js.t Js.prop

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. 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.

Defaults to: false

method maximized : bool Js.t Js.prop

True to initially display the window in a maximized state.

Defaults to: false

method minHeight : Js.number Js.t Js.prop

inherit docs

The minimum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Defaults to: 50

method minWidth : Js.number Js.t Js.prop

inherit docs

The minimum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Defaults to: 50

method minimizable : bool Js.t Js.prop

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. 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.

Defaults to: false

method modal : bool Js.t Js.prop

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

method onEsc : 'e. 'e Js.callback Js.prop

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.

method overlapHeader : bool Js.t Js.prop

True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is done automatically for you). Otherwise it is undefined. If you manually add rounded corners to a panel header which does not have frame:true, this will need to be set to true.

Defaults to: true

method plain : bool Js.t Js.prop

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

method resizable : 'f. 'f Js.t Js.prop

Specify as true to allow user resizing at each edge and corner of the window, false to disable resizing.

This may also be specified as a config object to Ext.resizer.Resizer

Defaults to: true

method x : Js.number Js.t Js.prop

The X position of the left edge of the window on initial showing. Defaults to centering the Window within the width of the Window's container Element (The Element that the Window is rendered to).

method y : Js.number Js.t Js.prop

The Y position of the top edge of the window on initial showing. Defaults to centering the Window within the height of the Window's container Element (The Element that the Window is rendered to).

method afterCollapse : ((< activeItem : 'i. 'i Js.t Js.prop; afterCollapse : 'g;
           afterComponentLayout : 'j 'k.
                                    ('h Js.t,
                                     Js.number Js.t ->
                                     Js.number Js.t -> 'j Js.t -> 'k Js.t -> unit)
                                    Js.meth_callback Js.writeonly_prop;
           afterExpand : ('h Js.t, bool Js.t -> unit) Js.meth_callback
                         Js.writeonly_prop;
           afterHide : 'l 'm.
                         ('h Js.t,
                          'l Js.callback Js.optdef -> 'm Js.t Js.optdef -> unit)
                         Js.meth_callback Js.writeonly_prop;
           afterLayout : 'n.
                           ('h Js.t,
                            (#Ext_layout_container_Container.t as 'n) Js.t -> unit)
                           Js.meth_callback Js.writeonly_prop;
           afterRender : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           afterSetPosition : ('h Js.t, Js.number Js.t -> Js.number Js.t -> unit)
                              Js.meth_callback Js.writeonly_prop;
           afterShow : 'o 'p 'q.
                         ('h Js.t,
                          'o Js.t Js.optdef ->
                          'p Js.callback Js.optdef -> 'q Js.t Js.optdef -> unit)
                         Js.meth_callback Js.writeonly_prop;
           anchorSize : 'r. 'r Js.t Js.prop; animCollapse : bool Js.t Js.prop;
           animateTarget : 'a. 'a Js.t Js.prop; autoDestroy : bool Js.t Js.prop;
           autoEl : 's. 's Js.t Js.prop; autoRender : 'b. 'b Js.t Js.prop;
           autoScroll : bool Js.t Js.prop; autoShow : bool Js.t Js.prop;
           baseCls : Js.js_string Js.t Js.prop; bbar : 't. 't Js.t Js.prop;
           beforeComponentLayout : ('h Js.t,
                                    Js.number Js.t -> Js.number Js.t -> unit)
                                   Js.meth_callback Js.writeonly_prop;
           beforeDestroy : ('h Js.t, unit -> unit) Js.meth_callback
                           Js.writeonly_prop;
           beforeLayout : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           beforeShow : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           bodyBorder : bool Js.t Js.prop; bodyCls : 'u. 'u Js.t Js.prop;
           bodyPadding : 'v. 'v Js.t Js.prop; bodyStyle : 'w. 'w Js.t Js.prop;
           border : 'x. 'x Js.t Js.prop;
           bubbleEvents : Js.js_string Js.t Js.js_array Js.t Js.prop;
           buttonAlign : Js.js_string Js.t Js.prop; buttons : 'y. 'y Js.t Js.prop;
           childEls : 'z. 'z Js.t Js.js_array Js.t Js.prop;
           closable : bool Js.t Js.prop; closeAction : Js.js_string Js.t Js.prop;
           cls : Js.js_string Js.t Js.prop;
           collapseDirection : Js.js_string Js.t Js.prop;
           collapseFirst : bool Js.t Js.prop;
           collapseMode : Js.js_string Js.t Js.prop; collapsed : bool Js.t Js.prop;
           collapsedCls : Js.js_string Js.t Js.prop;
           collapsible : bool Js.t Js.prop; columnWidth : 'a1. 'a1 Js.t Js.prop;
           componentCls : Js.js_string Js.t Js.prop;
           componentLayout : 'b1. 'b1 Js.t Js.prop; constrain : bool Js.t Js.prop;
           constrainHeader : bool Js.t Js.prop; constrainTo : 'c1. 'c1 Js.t Js.prop;
           constraintInsets : 'd1. 'd1 Js.t Js.prop;
           contentEl : Js.js_string Js.t Js.prop; data : 'e1. 'e1 Js.t Js.prop;
           defaultAlign : Js.js_string Js.t Js.prop;
           defaultDockWeights : 'f1. 'f1 Js.t Js.prop;
           defaultFocus : 'c. 'c Js.t Js.prop;
           defaultType : Js.js_string Js.t Js.prop;
           defaults : 'g1. 'g1 Js.t Js.prop; detachOnRemove : bool Js.t Js.prop;
           disabled : bool Js.t Js.prop; disabledCls : Js.js_string Js.t Js.prop;
           dockedItems : 'h1. 'h1 Js.t Js.prop; draggable : bool Js.t Js.prop;
           draggable_obj : 'i1. 'i1 Js.t Js.prop; expandOnShow : bool Js.t Js.prop;
           fbar : 'j1. 'j1 Js.t Js.prop; fixed : bool Js.t Js.prop;
           floatable : bool Js.t Js.prop; floating : bool Js.t Js.prop;
           focusOnToFront : bool Js.t Js.prop; formBind : bool Js.t Js.prop;
           frame : bool Js.t Js.prop; frameHeader : bool Js.t Js.prop;
           ghost : 'd. 'd Js.t Js.prop; glyph : 'k1. 'k1 Js.t Js.prop;
           header : 'l1. 'l1 Js.t Js.prop;
           headerOverCls : Js.js_string Js.t Js.prop;
           headerPosition : Js.js_string Js.t Js.prop;
           height : Js.number Js.t Js.prop; hidden : bool Js.t Js.prop;
           hideCollapseTool : bool Js.t Js.prop;
           hideMode : Js.js_string Js.t Js.prop;
           hideShadowOnDeactivate : bool Js.t Js.prop; html : 'm1. 'm1 Js.t Js.prop;
           icon : Js.js_string Js.t Js.prop; iconCls : Js.js_string Js.t Js.prop;
           id : Js.js_string Js.t Js.prop;
           initComponent : ('h Js.t, unit -> unit) Js.meth_callback
                           Js.writeonly_prop;
           itemId : Js.js_string Js.t Js.prop; items : 'n1. 'n1 Js.t Js.prop;
           layout : 'o1. 'o1 Js.t Js.prop; lbar : 'p1. 'p1 Js.t Js.prop;
           listeners : 'q1. 'q1 Js.t Js.prop; loader : 'r1. 'r1 Js.t Js.prop;
           manageHeight : bool Js.t Js.prop; margin : 's1. 's1 Js.t Js.prop;
           maxHeight : Js.number Js.t Js.prop; maxWidth : Js.number Js.t Js.prop;
           maximizable : bool Js.t Js.prop; maximized : bool Js.t Js.prop;
           minButtonWidth : Js.number Js.t Js.prop;
           minHeight : Js.number Js.t Js.prop; minWidth : Js.number Js.t Js.prop;
           minimizable : bool Js.t Js.prop; modal : bool Js.t Js.prop;
           onAdd : 't1.
                     ('h Js.t,
                      (#Ext_Component.t as 't1) Js.t -> Js.number Js.t -> unit)
                     Js.meth_callback Js.writeonly_prop;
           onAdded : 'u1.
                       ('h Js.t, 'u1 Js.t -> Js.number Js.t -> unit)
                       Js.meth_callback Js.writeonly_prop;
           onBeforeAdd : 'v1.
                           ('h Js.t, (#Ext_Component.t as 'v1) Js.t -> unit)
                           Js.meth_callback Js.writeonly_prop;
           onDestroy : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           onDisable : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           onDockedAdd : 'w1.
                           ('h Js.t, (#Ext_Component.t as 'w1) Js.t -> unit)
                           Js.meth_callback Js.writeonly_prop;
           onDockedRemove : 'x1.
                              ('h Js.t, (#Ext_Component.t as 'x1) Js.t -> unit)
                              Js.meth_callback Js.writeonly_prop;
           onEnable : ('h Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
           onEsc : 'e. 'e Js.callback Js.prop;
           onHide : 'y1 'z1 'a2.
                      ('h Js.t,
                       'y1 Js.t Js.optdef ->
                       'z1 Js.callback Js.optdef -> 'a2 Js.t Js.optdef -> unit)
                      Js.meth_callback Js.writeonly_prop;
           onPosition : ('h Js.t, Js.number Js.t -> Js.number Js.t -> unit)
                        Js.meth_callback Js.writeonly_prop;
           onRemove : 'b2.
                        ('h Js.t,
                         (#Ext_Component.t as 'b2) Js.t -> bool Js.t -> unit)
                        Js.meth_callback Js.writeonly_prop;
           onRemoved : ('h Js.t, bool Js.t -> unit) Js.meth_callback
                       Js.writeonly_prop;
           onRender : ('h Js.t, Ext_dom_Element.t Js.t -> Js.number Js.t -> unit)
                      Js.meth_callback Js.writeonly_prop;
           onResize : 'c2 'd2 'e2 'f2.
                        ('h Js.t,
                         'c2 Js.t -> 'd2 Js.t -> 'e2 Js.t -> 'f2 Js.t -> unit)
                        Js.meth_callback Js.writeonly_prop;
           onShow : 'g2 'h2 'i2.
                      ('h Js.t,
                       'g2 Js.t Js.optdef ->
                       'h2 Js.callback Js.optdef -> 'i2 Js.t Js.optdef -> unit)
                      Js.meth_callback Js.writeonly_prop;
           onShowComplete : 'j2 'k2.
                              ('h Js.t,
                               'j2 Js.callback Js.optdef ->
                               'k2 Js.t Js.optdef -> unit)
                              Js.meth_callback Js.writeonly_prop;
           overCls : Js.js_string Js.t Js.prop;
           overflowX : Js.js_string Js.t Js.prop;
           overflowY : Js.js_string Js.t Js.prop; overlapHeader : bool Js.t Js.prop;
           padding : 'l2. 'l2 Js.t Js.prop; placeholder : 'm2. 'm2 Js.t Js.prop;
           placeholderCollapseHideMode : Js.number Js.t Js.prop;
           plain : bool Js.t Js.prop; plugins : 'n2. 'n2 Js.t Js.prop;
           rbar : 'o2. 'o2 Js.t Js.prop; region : 'p2. 'p2 Js.t Js.prop;
           renderData : 'q2. 'q2 Js.t Js.prop;
           renderSelectors : 'r2. 'r2 Js.t Js.prop;
           renderTo : 's2. 's2 Js.t Js.prop; renderTpl : 't2. 't2 Js.t Js.prop;
           resizable : 'f. 'f Js.t Js.prop;
           resizeHandles : Js.js_string Js.t Js.prop; rtl : bool Js.t Js.prop;
           saveDelay : Js.number Js.t Js.prop; shadow : 'u2. 'u2 Js.t Js.prop;
           shadowOffset : Js.number Js.t Js.prop;
           shrinkWrap : 'v2. 'v2 Js.t Js.prop;
           shrinkWrapDock : 'w2. 'w2 Js.t Js.prop; simpleDrag : bool Js.t Js.prop;
           stateEvents : Js.js_string Js.t Js.js_array Js.t Js.prop;
           stateId : Js.js_string Js.t Js.prop; stateful : bool Js.t Js.prop;
           style : 'x2. 'x2 Js.t Js.prop; suspendLayout : bool Js.t Js.prop;
           tbar : 'y2. 'y2 Js.t Js.prop; title : Js.js_string Js.t Js.prop;
           titleAlign : Js.js_string Js.t Js.prop;
           titleCollapse : bool Js.t Js.prop; toFrontOnShow : bool Js.t Js.prop;
           tools : 'z2. 'z2 Js.t Js.prop; tpl : 'a3. 'a3 Js.t Js.prop;
           tplWriteMode : Js.js_string Js.t Js.prop; ui : Js.js_string Js.t Js.prop;
           width : Js.number Js.t Js.prop; x : Js.number Js.t Js.prop;
           xtype : Js.js_string Js.t Js.prop; y : Js.number Js.t Js.prop; .. >
         as 'h)
        Js.t, bool Js.t -> unit)
       Js.meth_callback Js.writeonly_prop as 'g

See method t.afterCollapse

method afterExpand : ('h Js.t, bool Js.t -> unit) Js.meth_callback Js.writeonly_prop

See method t.afterExpand

method onShow : 'g2 'h2 'i2.
         ('h Js.t,
          'g2 Js.t Js.optdef ->
          'h2 Js.callback Js.optdef -> 'i2 Js.t Js.optdef -> unit)
         Js.meth_callback Js.writeonly_prop

See method t.onShow