MODULES Uize.Widget.Dialog
- Contents
- 1. Introduction
- 2. DOM Nodes
- 3. Instance Properties
- 4. Instance Events
- 5. Child Widgets
-
6. State Properties
- 6.1. autoPosition
- 6.2. built
- 6.3. busy
- 6.4. busyInherited
- 6.5. busyParentTickle
- 6.6. cancelText
- 6.7. children
- 6.8. container
- 6.9. currentShieldOpacity
- 6.10. defaultCancelText
- 6.11. defaultOkText
- 6.12. defaultTitle
- 6.13. dismissOnShieldClick
- 6.14. enabled
- 6.15. enabledInherited
- 6.16. enabledParentTickle
- 6.17. height
- 6.18. hideShieldOnDrag
- 6.19. html
- 6.20. idPrefix
- 6.21. idPrefixConstruction
- 6.22. inDrag
- 6.23. insertionMode
- 6.24. isMaximized
- 6.25. localized
- 6.26. mooringNode
- 6.27. name
- 6.28. nodeMap
- 6.29. nodeToSetDimension
- 6.30. offsetRegistrationCorner
- 6.31. offsetX
- 6.32. offsetY
- 6.33. okEnabledOnShow
- 6.34. okText
- 6.35. parent
- 6.36. resizable
- 6.37. shieldOpacity
- 6.38. shieldShown
- 6.39. shown
- 6.40. title
- 6.41. width
- 6.42. wired
-
7. Instance Methods
- 7.1. addChild
- 7.2. addChildren
- 7.3. afterWireUi
- 7.4. ajax
- 7.5. atEndOfOmegaStructor
- 7.6. buildHtml
- 7.7. callInherited
- 7.8. childHtml
- 7.9. childId
- 7.10. confirm
- 7.11. displayNode
- 7.12. fire
- 7.13. flushNodeCache
- 7.14. get
- 7.15. getContainer
- 7.16. getHtml
- 7.17. getInherited
- 7.18. getNode
- 7.19. getNodeStyle
- 7.20. getNodeValue
- 7.21. getProvider
- 7.22. globalizeNode
- 7.23. inform
- 7.24. injectNodeHtml
- 7.25. insertOrWireUi
- 7.26. insertUi
- 7.27. is
- 7.28. isMet
- 7.29. kill
- 7.30. localize
- 7.31. met
- 7.32. nodeId
- 7.33. onChange
- 7.34. once
- 7.35. removeChild
- 7.36. removeNode
- 7.37. removeUi
- 7.38. responsiveUpdateUiPositionAndDimensions
- 7.39. set
- 7.40. setInherited
- 7.41. setNodeClipRect
- 7.42. setNodeInnerHtml
- 7.43. setNodeOpacity
- 7.44. setNodeProperties
- 7.45. setNodeStyle
- 7.46. setNodeValue
- 7.47. showNode
- 7.48. toggle
- 7.49. unmet
- 7.50. unwire
- 7.51. unwireNode
- 7.52. unwireNodeEventsByMatch
- 7.53. unwireUi
- 7.54. updateUi
- 7.55. updateUiDimsIfShown
- 7.56. updateUiPositionIfShown
- 7.57. valueOf
- 7.58. whenever
- 7.59. wire
- 7.60. wireNode
- 7.61. wireUi
-
8. Static Methods
- 8.1. Uize.Widget.Dialog.alphastructor
- 8.2. Uize.Widget.Dialog.declare
- 8.3. Uize.Widget.Dialog.doMy
- 8.4. Uize.Widget.Dialog.dualContextMethods
- 8.5. Uize.Widget.Dialog.dualContextProperties
- 8.6. Uize.Widget.Dialog.fire
- 8.7. Uize.Widget.Dialog.get
- 8.8. Uize.Widget.Dialog.getBlankImageUrl
- 8.9. Uize.Widget.Dialog.instanceMethods
- 8.10. Uize.Widget.Dialog.instanceProperties
- 8.11. Uize.Widget.Dialog.mixins
- 8.12. Uize.Widget.Dialog.omegastructor
- 8.13. Uize.Widget.Dialog.set
- 8.14. Uize.Widget.Dialog.singleton
- 8.15. Uize.Widget.Dialog.spawn
- 8.16. Uize.Widget.Dialog.stateProperties
- 8.17. Uize.Widget.Dialog.staticMethods
- 8.18. Uize.Widget.Dialog.staticProperties
- 8.19. Uize.Widget.Dialog.subclass
- 8.20. Uize.Widget.Dialog.toggle
- 8.21. Uize.Widget.Dialog.treeInheritedStateProperties
- 8.22. Uize.Widget.Dialog.unwire
- 8.23. Uize.Widget.Dialog.wire
-
9. Static Properties
- 9.1. Uize.Widget.Dialog.busyParentTickle
- 9.2. Uize.Widget.Dialog.enabledParentTickle
- 9.3. Uize.Widget.Dialog.isMaximized
- 9.4. Uize.Widget.Dialog.isWired
- 9.5. Uize.Widget.Dialog.moduleName
- 9.6. Uize.Widget.Dialog.nonInheritableStatics
- 9.7. Uize.Widget.Dialog.openDialogs
- 9.8. Uize.Widget.Dialog.pathToResources
- 9.9. Uize.Widget.Dialog.undefined
1. Introduction
The Uize.Widget.Dialog
class implements support for inline dialogs, with features like drag-and-drop moving, ok, cancel, and close buttons, and more.
DEVELOPERS: Chris van Rensburg
1.1. Examples
There are no dedicated showcase example pages for the Uize.Widget.Dialog
module.
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the Uize.Widget.Dialog
module...
SEARCH
1.2. Implementation Info
The Uize.Widget.Dialog
module defines the Uize.Widget.Dialog
class, which is a subclass of Uize.Widget
.
INHERITANCE CHAIN
Uize.Class
−> Uize.Widget
−> Uize.Widget.Dialog
1.2.1. Features Introduced in This Module
The features listed in this section have been introduced in this module.
INSTANCE METHODS
afterWireUi
| atEndOfOmegaStructor
| responsiveUpdateUiPositionAndDimensions
| updateUiDimsIfShown
| updateUiPositionIfShown
STATE PROPERTIES
autoPosition
| cancelText
| currentShieldOpacity
| defaultCancelText
| defaultOkText
| defaultTitle
| dismissOnShieldClick
| height
| hideShieldOnDrag
| inDrag
| isMaximized
| mooringNode
| nodeToSetDimension
| offsetRegistrationCorner
| offsetX
| offsetY
| okEnabledOnShow
| okText
| resizable
| shieldOpacity
| shieldShown
| shown
| title
| width
STATIC PROPERTIES
Uize.Widget.Dialog.isMaximized
| Uize.Widget.Dialog.openDialogs
1.2.2. Features Overridden in This Module
The features listed in this section have been overridden in this module.
The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
STATIC PROPERTIES
Uize.Widget.Dialog.moduleName
| Uize.Widget.Dialog.nonInheritableStatics
| Uize.Widget.Dialog.undefined
1.2.3. Features Inherited From Other Modules
The features listed in this section have been inherited from other modules.
The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
addChild
| addChildren
| ajax
| buildHtml
| callInherited
| childHtml
| childId
| confirm
| displayNode
| fire
| flushNodeCache
| get
| getContainer
| getHtml
| getInherited
| getNode
| getNodeStyle
| getNodeValue
| getProvider
| globalizeNode
| inform
| injectNodeHtml
| insertOrWireUi
| insertUi
| is
| isMet
| kill
| localize
| met
| nodeId
| onChange
| once
| removeChild
| removeNode
| removeUi
| set
| setInherited
| setNodeClipRect
| setNodeInnerHtml
| setNodeOpacity
| setNodeProperties
| setNodeStyle
| setNodeValue
| showNode
| toggle
| unmet
| unwire
| unwireNode
| unwireNodeEventsByMatch
| unwireUi
| whenever
| wire
| wireNode
INSTANCE PROPERTIES
STATE PROPERTIES
built
| busy
| busyInherited
| busyParentTickle
| children
| container
| enabled
| enabledInherited
| enabledParentTickle
| html
| idPrefix
| idPrefixConstruction
| insertionMode
| localized
| name
| nodeMap
| parent
| wired
STATIC METHODS
Uize.Widget.Dialog.alphastructor
| Uize.Widget.Dialog.declare
| Uize.Widget.Dialog.doMy
| Uize.Widget.Dialog.dualContextMethods
| Uize.Widget.Dialog.dualContextProperties
| Uize.Widget.Dialog.fire
| Uize.Widget.Dialog.get
| Uize.Widget.Dialog.getBlankImageUrl
| Uize.Widget.Dialog.instanceMethods
| Uize.Widget.Dialog.instanceProperties
| Uize.Widget.Dialog.mixins
| Uize.Widget.Dialog.omegastructor
| Uize.Widget.Dialog.set
| Uize.Widget.Dialog.singleton
| Uize.Widget.Dialog.spawn
| Uize.Widget.Dialog.stateProperties
| Uize.Widget.Dialog.staticMethods
| Uize.Widget.Dialog.staticProperties
| Uize.Widget.Dialog.subclass
| Uize.Widget.Dialog.toggle
| Uize.Widget.Dialog.treeInheritedStateProperties
| Uize.Widget.Dialog.unwire
| Uize.Widget.Dialog.wire
STATIC PROPERTIES
Uize.Widget.Dialog.busyParentTickle
| Uize.Widget.Dialog.enabledParentTickle
| Uize.Widget.Dialog.isWired
| Uize.Widget.Dialog.pathToResources
1.2.4. Modules Directly Under This Namespace
Uize.Widget.Dialog.Confirm
| Uize.Widget.Dialog.Form
| Uize.Widget.Dialog.Iframe
| Uize.Widget.Dialog.Picker
| Uize.Widget.Dialog.mConfirm
| Uize.Widget.Dialog.mForm
| Uize.Widget.Dialog.mPicker
| Uize.Widget.Dialog.mResizable
| Uize.Widget.Dialog.xResizable
1.2.5. Unit Tests
There is no dedicated unit tests module for the Uize.Widget.Dialog
module.
2. DOM Nodes
2.1. Root Node
A node that is the root for all of the dialog's HTML, excluding the shield
DOM node.
When a dialog is shown, its Root Node
and shield
DOM nodes are displayed. Conversely, when a dialog is hidden, both its Root Node
and shield
DOM nodes are hidden. When a dialog is dragged to a new position by the user, or if its position is programmatically changed, then the Root Node
is repositioned through CSS. If the dialog is resized by the user, or if it is resized programmatically by setting values for its width
and height
state properties, the dimensions of the Root Node
are modified through CSS. All chrome for the dialog should therefore be "pinned" to the Root Node
, so that when the dialog is moved and resized, the chrome goes along for the ride.
2.2. shield
A node that will be sized to fill the entire browser view port, in order to block events to the page behind the dialog.
When the dialog is shown, the shield
DOM node is shown along with the Root Node
. The shield can be set to hide when the user drag or resizes the dialog by setting the hideShieldOnDrag
state property to true
. When the dialog is shown, the shield can be hidden by setting the shieldShown
state property to false
. Even though the shield won't be visible, it will still block events to the page behind the dialog.
NOTES
see also the currentShieldOpacity , hideShieldOnDrag , shieldOpacity , and shieldShown state properties |
|
see also the shieldFade instance property |
2.3. title DOM Node
A node that acts as the title bar for the dialog and that is wired up by the drag
child widget to enable drag-to-move for the dialog.
The text for the dialog's title bar can be controlled via the title
and defaultTitle
state properties.
NOTES
if no title DOM Node is present in the dialog's HTML, then the dialog will not be movable |
|
see also the defaultTitle and title state properties |
3. Instance Properties
3.1. shieldFade
An instance of the Uize.Fade
class, that is used to fade the opacity of the shield
DOM node when hiding it.
This property lets you customize the qualities of the opacity fade for the dialog's shield
, by letting you set values for the state properties of the Uize.Fade
instance (such as duration
, curve
, etc.).
3.2. showConfirm
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
3.3. showInform
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
4. Instance Events
4.1. After Hide
An instance event that is fired immediately after the dialog is hidden.
NOTES
when this event is fired, the value of the shown state property will be false |
|
see also the Before Show , Before Hide , and After Show instance events |
4.2. After Show
An instance event that is fired immediately after the dialog is shown.
NOTES
when this event is fired, the value of the shown state property will be true |
|
see also the Before Show , Before Hide , and After Hide instance events |
4.3. Before Hide
An instance event that is fired immediately before the dialog is hidden.
NOTES
when this event is fired, the value of the shown state property will be false |
|
see also the Before Show , After Show , and After Hide instance events |
4.4. Before Show
An instance event that is fired immediately before the dialog is displayed.
NOTES
when this event is fired, the value of the shown state property will be true |
|
see also the Before Hide , After Show , and After Hide instance events |
4.5. Cancel
An instance event that is fired when the user clicks the cancel
button.
NOTES
the handler for this event can abort the closing of the dialog by setting the abort property of the event object to true |
4.6. Close
An instance event that is fired when the user clicks the close
button.
NOTES
the handler for this event can abort the closing of the dialog by setting the abort property of the event object to true |
4.7. Drag Done
An instance event that is fired each time the user finishes dragging the dialog (either when moving or resizing).
NOTES
see the related Drag Start instance event |
4.8. Drag Start
An instance event that is fired each time the user starts dragging the dialog (either for moving or resizing).
NOTES
compare to the First Drag Since Shown instance event |
|
see the related Drag Done instance event |
4.9. First Drag Since Shown
An instance event that is fired for only the first time that the dialog is dragged after it has been shown.
NOTES
compare to the Drag Start instance event |
|
see the related Drag Done instance event |
4.10. Ok
An instance event that is fired when the user clicks the ok
button.
NOTES
the handler for this event can abort the closing of the dialog by setting the abort property of the event object to true |
4.11. Qualified Ok
An instance event that is fired when the user clicks the qualifiedOk
button.
NOTES
the handler for this event can abort the closing of the dialog by setting the abort property of the event object to true |
5. Child Widgets
5.1. cancel
A button instance, that lets the user cancel (and close) the dialog.
When this button is clicked, the Cancel
event is fired on the dialog instance. The text for this button can be controlled via the cancelText
and defaultCancelText
state properties.
5.2. close
A button instance, that lets the user close the dialog.
When this button is clicked, the Close
event is fired on the dialog instance.
5.3. drag
An instance of the Uize.Widget.Drag
class, that is wired up to the title DOM Node
to enable drag-to-move for the dialog.
Setting the enabled
state property of this child widget to false
will disable drag-to-move for the dialog.
5.4. ok
A button instance, that lets the user submit the dialog.
When this button is clicked, the Ok
event is fired on the dialog instance. The text for this button can be controlled via the okText
and defaultOkText
state properties.
5.5. qualifiedOk
A button instance, that lets the user submit the dialog with a qualification.
The qualifiedOk
button is like a second ok
button (kind of like an "ok, but with this one condition..." action). Having a second ok-like button is useful in a few cases, but most dialogs will not provide markup for this button. When this button is clicked, the Qualified Ok
event is fired on the dialog instance.
6. State Properties
6.1. autoPosition
A boolean, indicating whether or not the dialog should be automatically positioned when it is shown, or whenever the browser window is resized.
When autoPosition
is set to true
, the dialog will be automatically positioned each time it is shown and each time the browser window is resized. When the dialog is positioned, the way in which it is positioned is determined by the value of the mooringNode
, offsetX
, and offsetY
state properties.
If the value of the mooringNode
state property resolves to a DOM node, then the dialog will be "moored" to the specified mooring node (for a more detailed explanation, see the reference for the mooringNode
state property). On the other hand, if the value of the mooringNode
state property is null
, undefined
, or does not resolve to a DOM node, then the dialog will be positioned so that it is centered in the browser window.
NOTES
the initial value is true |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.2. built
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.3. busy
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.4. busyInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.5. busyParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.6. cancelText
A string, representing text that should be displayed for the dialog's cancel
button.
Using this property, the text of the cancel
button can be changed at any time - even when the dialog is shown. Setting a non-empty string value for this property has the effect of setting the value of the text
state property for the cancel
child widget. Leaving cancelText
set to its initial value of undefined
will result in the cancel
button's text being determined by the value of the defaultCancelText
state property. If the values for both the cancelText
and defaultCancelText
state properties are undefined
, then the cancel
button will retain whatever text was initially in its HTML markup.
NOTES
see the companion defaultCancelText state property |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.7. children
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.8. container
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.9. currentShieldOpacity
A read-only floating point number in the range of 0
to 1
, indicating the current opacity level of the dialog's shield.
NOTES
this property is read-only | |
see the related hideShieldOnDrag , shieldOpacity , and shieldShown state properties, and the shield DOM node |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.10. defaultCancelText
A string, specifying the default text for the cancel
button, should the cancelText
state property be set to null
, undefined
, or ''
(an empty string).
For a more detailed explanation of the cancel button text fallback mechanism, see the reference for the cancelText
state property.
NOTES
see the companion cancelText state property |
|
when the cancelText state property is set to a non-empty string, then defaultCancelText will have no effect |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.11. defaultOkText
A string, specifying the default text for the ok
button, should the okText
state property be set to null
, undefined
, or ''
(an empty string).
For a more detailed explanation of the ok button text fallback mechanism, see the reference for the okText
state property.
NOTES
see the companion okText state property |
|
when the okText state property is set to a non-empty string, then defaultOkText will have no effect |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.12. defaultTitle
A string, specifying the default text for the title DOM Node
(i.e. the title bar), should the title
state property be set to null
, undefined
, or ''
(an empty string).
For a more detailed explanation of the title text fallback mechanism, see the reference for the title
state property.
NOTES
see the companion title state property |
|
when the title state property is set to a non-empty string, then defaultTitle will have no effect |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.13. dismissOnShieldClick
A boolean, specifying whether or not clicking the shield
node should close the dialog, or a string, specifying a dialog dismissal event that should be fired when the dialog is dismissed by clicking on the shield
node.
A "chromeless" dialog may be desired in some case in order to display a palette without the visual clutter of title and button bars. In this case, there may not be a close
button, so clicking outside of the dialog (on the shield
DOM node) would be one way to close the dialog.
NOTES
the initial value is false |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.14. enabled
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.15. enabledInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.16. enabledParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.17. height
An integer, specifying the height of the dialog (i.e. the height of its Root Node
).
When a dialog is resizable (by using the Uize.Widget.Dialog.xResizable
extension), the value of the height
and state property will be updated when the user has completed resizing the dialog. Updating the value of this property programmatically while the dialog is shown will cause it to be resized. Leaving height
set to its initial value of undefined
will result in the dialog's height remaining as determined by its initial HTML markup and CSS.
NOTES
see the companion width state property |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.18. hideShieldOnDrag
A boolean, specifying whether or not the shield
DOM node should be hidden when the dialog is dragged (moved or resized).
When the user drags a dialog, it is considered that one possible reason is to see what is being obscured by it. This can be the case if the user wishes to reference what is on the page behind the dialog in order to inform what choices they make in the dialog's UI. Therefore, the hideShieldOnDrag
state property is initially set to true
. Setting this property to false
means that the shield
DOM node will remain obscuring the page even when the user drags the dialog.
NOTES
the initial value is true |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.19. html
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.20. idPrefix
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.21. idPrefixConstruction
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.22. inDrag
A read-only boolean, indicating whether or not the dialog is being dragged (moved or resized).
NOTES
this property is read-only | |
the initial value is false |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.23. insertionMode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.24. isMaximized
IMPLEMENTATION INFO
this feature was introduced in this module |
6.25. localized
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.26. mooringNode
A node reference or node ID for a node to which the dialog should be "moored".
When the value of the mooringNode
state property resolves to a DOM node and the autoPosition
state property is set to true
, then the dialog is considered moored to the specified mooring node. On the other hand, if the autoPosition
state property is set to false
, then the value of the mooringNode
, offsetX
, and offsetY
state properties will have no effect.
When in the moored state, the dialog will maintain its offset position relative to the mooring node, as specified by the offsetX
and offsetY
state properties - even as the browser window is resized. Each time it is shown or the browser window is resized, the dialog will be re-positioned so that the top left corner of its Root Node
is offset vertically and horizontally from the top left corner of the mooring node, by the number of pixels specified by the offsetY
and offsetX
state properties, respectively.
NOTES
see the related autoPosition , offsetRegistrationCorner , offsetX , and offsetY state properties |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.27. name
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.28. nodeMap
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.29. nodeToSetDimension
A node reference or node ID for a node to which the height
and width
should be set.
The default value is the root node. Setting this property is useful when the main content of the dialog is in a child node.
NOTES
see the companion height set-get property |
|
see the companion width set-get property |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.30. offsetRegistrationCorner
A pipe-separated string, specifying the registration corner of the dialog (i.e. which side of the dialog is moored to mooringNode
).
NOTES
when the autoPosition state property is set to false , then offsetRegistrationCorner has no effect |
|
see the related autoPosition , mooringNode , and offsetY state properties |
|
the initial value is 'top|left' |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.31. offsetX
An integer, specifying the offset in pixels from the left edge of the mooringNode
to the left edge of the dialog's Root Node
.
When a dialog is "moored" to a mooring node, the offsetX
property specifies how it is horizontally positioned in relation to the mooring node (for a more detailed explanation, see the reference for the mooringNode
state property).
NOTES
when the autoPosition state property is set to false , then offsetX has no effect |
|
see the related autoPosition , mooringNode , offsetRegistrationCorner , and offsetY state properties |
|
the initial value is 0 |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.32. offsetY
An integer, specifying the offset in pixels from the top edge of the mooringNode
to the top edge of the dialog's Root Node
.
When a dialog is "moored" to a mooring node, the offsetY
property specifies how it is vertically positioned in relation to the mooring node (for a more detailed explanation, see the reference for the mooringNode
state property).
NOTES
when the autoPosition state property is set to false , then offsetY has no effect |
|
see the related autoPosition , mooringNode , offsetRegistrationCorner , and offsetX state properties |
|
the initial value is 0 |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.33. okEnabledOnShow
A boolean, specifying whether the dialog's ok
button should be enabled or disabled each time the dialog is shown.
A value of true
means that the ok
button will be enabled each time the dialog is shown, a value of false
means that the ok
button will be disabled each time the dialog is shown (useful for dialogs that need to perform validation before enabling the ok
button), and a value of undefined
means that the enabled
state of the ok
button will not be modified upon showing the dialog.
NOTES
the initial value is true |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.34. okText
A string, representing text that should be displayed for the dialog's ok
button.
Using this property, the text of the ok
button can be changed at any time - even when the dialog is shown. Setting a non-empty string value for this property has the effect of setting the value of the text
state property for the ok
child widget. Leaving okText
set to its initial value of undefined
will result in the ok
button's text being determined by the value of the defaultOkText
state property. If the values for both the okText
and defaultOkText
state properties are undefined
, then the ok
button will retain whatever text was initially in its HTML markup.
NOTES
see the companion defaultOkText state property |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.35. parent
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.36. resizable
IMPLEMENTATION INFO
this feature was introduced in this module |
6.37. shieldOpacity
A floating point number in the range of 0
to 1
, specifying the opacity for the shield
DOM node when it is shown.
NOTES
see the related currentShieldOpacity , hideShieldOnDrag , and shieldShown state properties, and the shield DOM node |
|
the initial value is .3 |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.38. shieldShown
A boolean, specifying whether or not the shield
DOM node is shown.
Whenever this property is set to true
, the shield
DOM node will be revealed. When it is set to false
, the shield
will be hidden. This property is set to true
each time the dialog is shown, and it is set to false
the first time the dialog is dragged after being shown (provided that the hideShieldOnDrag
state property is set to true
). You can also programmatically set shieldShown
to false
in your dialog code if some action requires that the user be able to see the page behind the dialog.
NOTES
see the related currentShieldOpacity , hideShieldOnDrag , and shieldOpacity state properties, and the shield DOM node |
|
the initial value is false |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.39. shown
A boolean, specifying whether or not the dialog is shown.
In order to show a dialog, just set the value of this property to true
. To hide a dialog, set the value of this property to false
. When a dialog is shown, clicking on its ok
, qualifiedOk
, cancel
, or close
buttons will result in the shown
property being set back to false
(unless the associated Ok
, Qualified Ok
, Cancel
, or Close
dismiss events are aborted). When the shown
state of a dialog is changed, the Before Show
, After Show
, Before Hide
, and After Hide
instance events are fired at various phases of the reveal or hide process.
NOTES
the initial value is false |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.40. title
A string, specifying text that should be displayed in the dialog's title DOM Node
(i.e. the title bar).
Using this property, the title of a dialog can be changed at any time - even when the dialog is shown. Leaving title
set to its initial value of undefined
will result in the dialog's title being determined by the value of the defaultTitle
state property. If the values for both the title
and defaultTitle
state properties are undefined
, then the title DOM Node
will retain whatever text was initially in its HTML markup.
NOTES
see the companion defaultTitle state property |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.41. width
An integer, specifying the width of the dialog (i.e. the width of its Root Node
).
When a dialog is resizable (by using the Uize.Widget.Dialog.xResizable
extension), the value of the width
and state property will be updated when the user has completed resizing the dialog. Updating the value of this property programmatically while the dialog is shown will cause it to be resized. Leaving width
set to its initial value of undefined
will result in the dialog's width remaining as determined by its initial HTML markup and CSS.
NOTES
see the companion height state property |
|
the initial value is undefined |
IMPLEMENTATION INFO
this feature was introduced in this module |
6.42. wired
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7. Instance Methods
7.1. addChild
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.2. addChildren
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.3. afterWireUi
IMPLEMENTATION INFO
this feature was introduced in this module |
7.4. ajax
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.5. atEndOfOmegaStructor
IMPLEMENTATION INFO
this feature was introduced in this module |
7.6. buildHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.7. callInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.8. childHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.9. childId
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.10. confirm
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.11. displayNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.12. fire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.13. flushNodeCache
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.14. get
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.15. getContainer
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.16. getHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.17. getInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.18. getNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.19. getNodeStyle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.20. getNodeValue
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.21. getProvider
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.22. globalizeNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.23. inform
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.24. injectNodeHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.25. insertOrWireUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.26. insertUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.27. is
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.28. isMet
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.29. kill
Inherited from Uize.Widget
, but introduced in Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Class ) |
7.30. localize
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.31. met
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.32. nodeId
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.33. onChange
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.34. once
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.35. removeChild
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.36. removeNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.37. removeUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.38. responsiveUpdateUiPositionAndDimensions
IMPLEMENTATION INFO
this feature was introduced in this module |
7.39. set
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.40. setInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.41. setNodeClipRect
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.42. setNodeInnerHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.43. setNodeOpacity
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.44. setNodeProperties
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.45. setNodeStyle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.46. setNodeValue
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.47. showNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.48. toggle
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.49. unmet
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.50. unwire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.51. unwireNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.52. unwireNodeEventsByMatch
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.53. unwireUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.54. updateUi
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget ) |
7.55. updateUiDimsIfShown
IMPLEMENTATION INFO
this feature was introduced in this module |
7.56. updateUiPositionIfShown
IMPLEMENTATION INFO
this feature was introduced in this module |
7.57. valueOf
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
IMPLEMENTATION INFO
7.58. whenever
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.59. wire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
7.60. wireNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7.61. wireUi
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget ) |
8. Static Methods
8.1. Uize.Widget.Dialog.alphastructor
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.2. Uize.Widget.Dialog.declare
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.3. Uize.Widget.Dialog.doMy
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.4. Uize.Widget.Dialog.dualContextMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.5. Uize.Widget.Dialog.dualContextProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.6. Uize.Widget.Dialog.fire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.7. Uize.Widget.Dialog.get
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.8. Uize.Widget.Dialog.getBlankImageUrl
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.9. Uize.Widget.Dialog.instanceMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.10. Uize.Widget.Dialog.instanceProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.11. Uize.Widget.Dialog.mixins
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.12. Uize.Widget.Dialog.omegastructor
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.13. Uize.Widget.Dialog.set
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.14. Uize.Widget.Dialog.singleton
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.15. Uize.Widget.Dialog.spawn
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.16. Uize.Widget.Dialog.stateProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.17. Uize.Widget.Dialog.staticMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.18. Uize.Widget.Dialog.staticProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.19. Uize.Widget.Dialog.subclass
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.20. Uize.Widget.Dialog.toggle
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.21. Uize.Widget.Dialog.treeInheritedStateProperties
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.22. Uize.Widget.Dialog.unwire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.23. Uize.Widget.Dialog.wire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
9. Static Properties
9.1. Uize.Widget.Dialog.busyParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
9.2. Uize.Widget.Dialog.enabledParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
9.3. Uize.Widget.Dialog.isMaximized
IMPLEMENTATION INFO
this feature was introduced in this module | |
this static feature is inherited by subclasses |
9.4. Uize.Widget.Dialog.isWired
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
9.5. Uize.Widget.Dialog.moduleName
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
9.6. Uize.Widget.Dialog.nonInheritableStatics
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
|
this static feature is not inherited by subclasses |
9.7. Uize.Widget.Dialog.openDialogs
IMPLEMENTATION INFO
this feature was introduced in this module | |
this static feature is inherited by subclasses |
9.8. Uize.Widget.Dialog.pathToResources
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
9.9. Uize.Widget.Dialog.undefined
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |