Specialized group for creating a set of modal components displayed within a page. More...

Inheritance diagram for modalGroup:

[legend]

Collaboration diagram for modalGroup:

[legend]

Public Member Functions
	actionHandler ()
	This method handles user actions within a pre-defined. More...

	constrainDragX (engine, wrapper, intendedX)
	Limit the x-axis changes to the current screen size.

	constrainDragY (engine, wrapper, intendedY)
	Limit the y-axis changes to the current screen size.

	endDrag (engine, wrapper)
	Callback from the ZLM drag which is used to clean up.

	getFloatingDiv ()
	Return the HTML element used to display this modal group.

	getModalBodyContent (update)
	Helper method to get the content for static modalGroups. More...

_.Library.String	getValue ()
	Client-side method to return the value associated with this group.

	hideGroup ()
	Hide the group.

	mousedownHandler (evt)
	mousedownHandler: handles start of move operation

	mousemoveHandler (evt)
	mousemoveHandler: handles move operation

	mouseupHandler (evt)
	mouseupHandler: handles end of move operation

	onCanEndModalHandler ()
	Don't allow the dialog to be closed unless the user explicitly does something. More...

	onDelete ()
	Ensure that we remove the floating div when the component is deleted.

	onEndModalHandler (zindex)
	Notification that this component is about to stop being modal.

	onRefreshContents ()
	Make sure that we correctly track the HTML for static modal groups.

	onStartModalHandler (zindex)
	Notification that this component is about to become modal.

	show (title, type, value, top, left, wid, hgt, parms)
	Make this group visible with modal behavior. More...

	startZLMDrag (evt)
	Start ZLM drag once this._dragData has been set up.

	startZLMMove (evt)
	Start the ZLM drag-based move operation.

	startZLMResize (evt)
	Start the ZLM drag-based resize operation.

	toggleDragMouseTrap (show)
	Toggle "visibility" of dragMouseTrap. More...

Public Member Functions inherited from group
	LayoutChildren (_.Library.Integer pTuple)
	Does the actual work of laying out the children of this group. More...

	setProperty (property, value, value2)
	Set the value of a named property. More...

Public Member Functions inherited from abstractGroup
	addChild (component, refresh)
	Client-side method. More...

	addChildAfter (component, sibling, refresh)
	Client-side method. More...

	addChildBefore (component, sibling, refresh)
	Client-side method. More...

	childrenMutated ()
	Notification to subclasses that a child has been added or removed. More...

	exposeComponent ()
	This manages the ondisplay event callback handling. More...

	getChildIndex (child)
	Look for the given child object within this group's set of. More...

	ondisabledHandler ()
	Client-side method that is called when a group's disabled. More...

	onloadHandler ()
	This client event, if present, is fired when the page is loaded.

	removeChild (component)
	Client-side method. More...

	setOverlayMode (mode)
	Set overlay mode for each child of this group.

	setPropertyAll (property, value, value2)
	Apply the given value to the specified property for. More...

Public Member Functions inherited from component
	dragFinishHandler (dragData)
	This is called when a drag operation started within this component. More...

	dragHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dragNotifyHandler (dragData)
	This is called by the layout manager when a drag operation. More...

	dragStartHandler (dragData)
	This is called when a drag operation is started within this component. More...

	dropHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dropStartHandler (dragData)
	This is called when a data drop operation is started within this component. More...

	getEnclosingDiv ()
	Client-side method returns the div element that encloses. More...

_.Library.String	getHidden ()
	Return whether this component is hidden.

	getHintElement ()
	Client-side method returns the HTML element that displays. More...

	getLabelElement ()
	Client-side method returns the HTML element that displays. More...

	onDisplayHandler ()
	This client callback is called from exposeComponent after. More...

	onPopupAction (popupName, action, value)
	This client event, if present, is fired when a popup page has specified. More...

	refreshContents (sync)
	This method, called from a client page, invokes this component's. More...

	setHidden (flag)
	If flag is true, hide this component. More...

	startProgressBar (div)
	Start the display of a progress bar within display. More...

	stopProgressBar ()
	Stop the timer used by the Progress bar.

Public Member Functions inherited from object
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...

	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...

	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...

_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...

	getSettings (settings)
	Client-side method that returns a list of this component's. More...

	getType ()
	Returns the component type of this object. More...

	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...

	isOfType (type)
	Returns true if this object is of the given component type. More...

	makeId (subid)
	client-side utility method that constructs a component-specific id More...

	onCreate ()
	This client method, if present, is called when this component is. More...

	onSerialize ()
	This client event, if present, is fired before a component. More...

	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...

	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.

	render ()
	This causes a component that draws its contents dynamically. More...

	renderContents ()
	This method, if present, is called when this component. More...

	renderSVG (document, parent)
	This method is only needed for SVG components. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Attributes
	groupTitle
	Title to display at top of modal group. More...

	groupType
	If set, this indicates that a pre-defined modalGroup. More...

	okCaption
	Localizable "OK" caption displayed in OK button for a message box. More...

	onaction
	onaction event handler: More...

	onhideGroup
	onhideGroup event handler: More...

	onshowGroup
	onshowGroup event handler: More...

	seed
	Optional. More...

	value
	This is used to hold a value for the modalGroup. More...

Public Attributes inherited from group
	cellAlign
	Specifies horizontal alignment of cells layed out within this group. More...

	cellSize
	Specifies how the size of cells within this group should be calculated (along layout direction). More...

	cellStyle
	Specifies additional style for cells layed out within this group. More...

	cellVAlign
	Specifies vertical alignment of cells layed out within this group. More...

	groupClass
	Optional CSS class used for table displayed by this group. More...

	groupStyle
	Optional style used for table displayed by this group. More...

	labelPosition
	Specifies where labels should be displayed for components within this group. More...

	layout
	Specifies how components within this group should be layed out. More...

	onclick
	onclick event handler: More...

Public Attributes inherited from abstractGroup
	children
	Set of components within this group. More...

	disabled
	If true, this group and its children are disabled. More...

Public Attributes inherited from component
	align
	Specifies how this component should be horizontally aligned within its layout cell. More...

	containerStyle
	CSS style applied to the td element used to contain this child component within. More...

	dragEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	dropEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	enclosingClass
	Optional CSS class used for this component's enclosing div. More...

	enclosingStyle
	Optional CSS style applied to this component's enclosing div. More...

	error
	Run-time value; Set to indicate an error within this component. More...

	height
	Specifies the height of this component with respect to its container. More...

	hidden
	If true, this component is hidden. More...

	hint
	User defined hint text used to display additional hint text for this component. More...

	hintClass
	Optional CSS class used for the component hint. More...

	hintStyle
	User defined style used for the component hint. More...

	label
	User defined label used to label this component. More...

	labelClass
	Optional CSS class used for the component label. More...

	labelDisabledClass
	Optional CSS class used for the component label when disabled. More...

	labelStyle
	User defined style used for the component label. More...

	onafterdrag
	onafterdrag event handler: More...

	onbeforedrag
	onbeforedrag event handler: More...

	ondrag
	ondrag event handler: More...

	ondrop
	ondrop event handler: More...

	onhide
	onhide event handler: More...

	onrefresh
	onrefresh event handler: More...

	onshow
	onshow event handler: More...

	showLabel
	Controls whether a label is displayed for this component. More...

	slice
	User-defined number of units of relative space this. More...

	title
	Help text (tool tip) displayed when mouse hovers over this component (or its label). More...

	valign
	Specifies how this component should be vertically aligned within its layout cell. More...

	width
	Specifies the width of this component with respect to its container. More...

Public Attributes inherited from object
	aux
	@qualifier final This is an auxiliary property that is provided More...

	composite
	@qualifier final For components that are created as part of a composite component, More...

	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...

	index
	@qualifier final System-assigned index number used internally to identify this component. More...

	name
	@qualifier final Name of this object. More...

	onupdate
	onupdate event handler: More...

	parent
	@qualifier final Link to the component that contains this object More...

	tuple
	@qualifier final Special property indicating which tuple of a More...

	visible
	This property indicates whether a component is visible and thus layed out. More...

	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Static Public Attributes
	DEFAULTHIDDEN = None
	Specialized group for creating a set of modal components displayed within a page. More...

Static Public Attributes inherited from group
	DEFAULTCELLALIGN = None
	Subclasses can set this to change default cellAlign for a group.

	DEFAULTCELLSIZE = None
	Subclasses can set this to change default cellSize for a group.

	DEFAULTCELLSTYLE = None
	Subclasses can set this to change default cellStyle for a group.

	DEFAULTCELLVALIGN = None
	Subclasses can set this to change default cellVAlign for a group.

	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

	DEFAULTGROUPSTYLE = None
	Subclasses can set this to change default groupStyle for a group.

	DEFAULTLABELPOSITION = None
	Subclasses can set this to change default labelPosition for a group.

	DEFAULTLAYOUT = None
	Subclasses can set this to change default layout for a group.

Static Public Attributes inherited from abstractGroup
	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

Static Public Attributes inherited from component
	DEFAULTENCLOSINGCLASS = None
	Subclasses can set this to change default enclosingClass used for this. More...

	DEFAULTHEIGHT = None
	Subclasses can set this to change default height for a component.

	DEFAULTHIDDEN = None
	Subclasses can set this to change default hidden property for a component.

	DEFAULTHINTCLASS = None
	Subclasses can set this to change default css class used for hints.

	DEFAULTLABELCLASS = None
	Subclasses can set this to change default css class used for labels.

	DEFAULTLABELDISABLEDCLASS = None
	Subclasses can set this to change default css class used for disabled labels.

	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	DEFAULTWIDTH = None
	Subclasses can set this to change default width for a component.

Static Public Attributes inherited from object
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...

	MODULE = None
	If set, this indicates that this system component should be. More...

	NAMESPACE = None
	This is the XML namespace used for library components.

	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...

	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Additional Inherited Members
Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Detailed Description

Specialized group for creating a set of modal components displayed within a page.

To display a modalGroup, use the modalGroup's <method>show</method> method. Use the zenPage object's <method>endModal</method> to remove the modalGroup.
You can define the contents of a modalGroup in three different ways:

Static mode: The modalGroup is defined within a page definition in the same way as any other group. The contents of the group will be hidden until the <method>show</method> is called.
Dynamic mode: The application creates a modalGroup dynamically (using the page's <method>createComponent</method> method), adds components to it, and displays it with the <method>show</method> method.
Built-in mode: The application uses the <method>show</method> method to display one of the built-in groups: "msgBox" or "calendar".

Member Function Documentation

◆ actionHandler()

actionHandler ( )

This method handles user actions within a pre-defined.

modalGroup.

◆ getModalBodyContent()

getModalBodyContent ( update )

Helper method to get the content for static modalGroups.

If the enclosing div has content, that content is returned, and the enclosing div's content is cleared. If update is true AND the modalBody element for this group exists (i.e. the group has been displayed), then the modalBody's content is updated to the new value.

◆ onCanEndModalHandler()

onCanEndModalHandler ( )

Don't allow the dialog to be closed unless the user explicitly does something.

to close the popup or fire a valid action.

◆ show()

show	(	title,
		type,
		value,
		top,
		left,
		wid,
		hgt,
		parms
	)

Make this group visible with modal behavior.

title is the optional title to display for the group. For a static group, the application-defined value of <property>groupTitle</property> is used if title is not supplied.
type is the optional type of modalGroup to display. This can be:

"msgBox"-display the built-in message box.
"calendar"-display the built-in calendar box.
"dynamic"-display a dynamically created modalGroup.
"static"-display a modalGroup that has been defined as part of the page.
"dialog"-display the page with the URL supplied in value

in an iframe. If omitted, then the type will be "static" if the modalGroup has been defined within the page object otherwise "dynamic".
value is an optional value to display when a built-in modalGroup is used.
top,left,wid, and hgt are optional position and dimensions to use for the modalGroup.
parms is an optional object containing a set of additional characteristics passed on to the modalGroup (as a set of name/value pairs). Basically this is a way to pass additional parameters to the popup calendar.

◆ toggleDragMouseTrap()

toggleDragMouseTrap ( show )

Toggle "visibility" of dragMouseTrap.

The trap should be completely transparent

but allows the component to trap mouse events reliably during drag operations.

Member Data Documentation

◆ DEFAULTHIDDEN

DEFAULTHIDDEN = None

static

Specialized group for creating a set of modal components displayed within a page.

To display a modalGroup, use the modalGroup's <method>show</method> method. Use the zenPage object's <method>endModal</method> to remove the modalGroup.
You can define the contents of a modalGroup in three different ways:

Static mode: The modalGroup is defined within a page definition in the same way as any other group. The contents of the group will be hidden until the <method>show</method> is called.
Dynamic mode: The application creates a modalGroup dynamically (using the page's <method>createComponent</method> method), adds components to it, and displays it with the <method>show</method> method.
Built-in mode: The application uses the <method>show</method> method to display one of the built-in groups: "msgBox" or "calendar".

◆ groupTitle

groupTitle

Title to display at top of modal group.

This is set dynamically by the <method>show</method> method. For static modalGroups, it can be set in the original page definition.

◆ groupType

groupType

If set, this indicates that a pre-defined modalGroup.

of the specified type should be displayed. This is set by the <method>show</method> method; applications should not set this.

◆ okCaption

okCaption

Localizable "OK" caption displayed in OK button for a message box.

◆ onaction

onaction

onaction event handler:

client code to run when user takes action with pre-defined modalGroup.

◆ onhideGroup

onhideGroup

onhideGroup event handler:

This event is fired when the modalGroup is hidden.

◆ onshowGroup

onshowGroup

onshowGroup event handler:

This event is fired when the modalGroup is made visible.

◆ seed

seed

Optional.

User-defined seed value. This is an optional parameter that is passed on to the <property>onaction</property> event handler.

◆ value

value

This is used to hold a value for the modalGroup.

This is set by the <method>show</method> method; applications should not set this.

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members