Class ecm.widget.dialog.BaseDialog

Extends dijit.Dialog.
Provides the base dialog box from which all other ecm.widget.dialog dialog box classes are derived.

To specify the content of a dialog box, use a contentString object and not a templateString object.
Defined in: <ecm\widget\dialog\BaseDialog.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.dialog.BaseDialog()

Field Summary

Field Attributes	Field Name and Description
	fitContentArea A boolean value that controls whether or not the content area is automatically fitted within the dialog box.
	lockFullscreen If true, the dialog is displayed as fullscreen and restore button is hidden.

Method Summary

Method Attributes	Method Name and Description
	addButton(buttonLabel, clickFunction, disabled, isDefault, idPrefix) Adds a button to the dialog's button bar.
	appendSecondaryMessage(text, category) Displays a category "error", "warning", "info" or "confirm" text message at the top of the dialog box, under the dialog's main text message which may be hidden.
	buildRendering() Builds the rendering, using `contentString` as the HTML template for the content area of the dialog box.
	clearMessage() Clears the text message at the top of the dialog, under the dialog's introduction text.
	clearSecondaryMessage(category) Clears the secondary text message at the top of the dialog, under the dialog's main text message which may be hidden.
	destroy() Destroys the dialog box.
	hide() Hides the dialog.
	isMaximized() Returns a boolean indicating if the dialog is maximized.
	onDragOver(evt) Displays the drag over not allowed icon.
	postCreate()
	resize(coords) Overrides the `dijit.Dialog` resize behavior.
	setIntroText(text) Sets the introduction text on the dialog box.
	setIntroTextRef(text, link) Sets the introduction text reference link on the dialog box.
	setMaximized(bool) Set the dialog as maximized or restored.
	setMessage(text, category) Displays a category "error", "warning", "info" or "confirm" text message at the top of the dialog box, under the dialog's introduction text.
	setReferenceLink(text, link, hoverHelp) Sets a hyperlink that is displayed in the action bar, on the opposite side of the buttons.
	setResizable(resizable) Enables or disables resizing of the dialog box.
	setSize(width, height) Sets both the width and height of the dialog box in pixels.
	setSizeToViewportRatio(bool) Automatically resize this dialog to the browser's viewport ratio (height and width) when the dialog is not maximized and the browser window is resized by the user.
	setTitle(title) Sets the title of the dialog box.
	setWidth(width) Sets the width of the dialog box (in pixels).
	show() Prevent drag over the underlay.
	showActionBar(show) Shows or hides the action bar.

Constructor Detail

ecm.widget.dialog.BaseDialog()

Field Detail

fitContentArea

A boolean value that controls whether or not the content area is automatically fitted within the dialog box. If true, the dialog box will not be automatically sized to fit around the content area.

lockFullscreen

If true, the dialog is displayed as fullscreen and restore button is hidden.

Since:: 2.0.3.3

Method Detail

addButton(buttonLabel, clickFunction, disabled, isDefault, idPrefix)

Adds a button to the dialog's button bar. Returns the dojo.form.Button instance created for the button.

Parameters:
buttonLabel: The label to use for the button.
clickFunction: The name of a function in this object to call when the button is clicked.
disabled: If true, the button will be initially disabled.
isDefault: If true, this button will be clicked when the Enter key is pressed anywhere on the dialog.
idPrefix: if provided, this string is added to the front of the dynamically generated button widget id string. This makes it easier to identify the dynamically created button by it's id.

appendSecondaryMessage(text, category)

Displays a category "error", "warning", "info" or "confirm" text message at the top of the dialog box, under the dialog's main text message which may be hidden.

Parameters:
text: The text of the message.
category: The message category - "error", "warning", "info" or "confirm". If not provided "error" is assumed.

Since:: 2.0.3.2

buildRendering()

Builds the rendering, using contentString as the HTML template for the content area of the dialog box.

clearMessage()

Clears the text message at the top of the dialog, under the dialog's introduction text.

Note: LoginPane.js contains a copy of this method.

clearSecondaryMessage(category)

Clears the secondary text message at the top of the dialog, under the dialog's main text message which may be hidden.

Parameters:
category: The message category - "error", "warning", "info" or "confirm". If not provided "error" is assumed.

Since:: 2.0.3.2

destroy()

Destroys the dialog box. This method should be called when the dialog box is no longer needed, to prevent memory leaks.

hide()

Hides the dialog.

isMaximized()

Returns a boolean indicating if the dialog is maximized.

Since:: 2.0.3

onDragOver(evt)

Displays the drag over not allowed icon.

Parameters:
evt

postCreate()

resize(coords)

Overrides the dijit.Dialog resize behavior. If the content area contains a widget that implements resize, then that widget's resize method will be invoked as well.

Parameters:
coords

setIntroText(text)

Sets the introduction text on the dialog box. This is text that appears below the title bar that describes how to use the dialog.

Parameters:
text

setIntroTextRef(text, link)

Sets the introduction text reference link on the dialog box. This is a link that appears after the introduction text.

Parameters:
text
link

setMaximized(bool)

Set the dialog as maximized or restored.

Parameters:
bool: Boolean indicating if the dialog should be maximized.

Since:: 2.0.3

setMessage(text, category)

Displays a category "error", "warning", "info" or "confirm" text message at the top of the dialog box, under the dialog's introduction text.

Note: LoginPane.js contains a copy of this method.

Parameters:
text: The text of the message.
category: The message category - "error", "warning", "info" or "confirm". If not provided "error" is assumed.

setReferenceLink(text, link, hoverHelp)

Sets a hyperlink that is displayed in the action bar, on the opposite side of the buttons. This hyperlink is used to provide the message identifier and link to additional information in the error dialog.

Parameters:
text: The text of the reference.
link: The URL of the hyperlink.
hoverHelp

setResizable(resizable)

Enables or disables resizing of the dialog box. A resize indicator appears on the bottom trailing corner of the dialog box to indicate that it can be resized.

Parameters:
resizable

setSize(width, height)

Sets both the width and height of the dialog box in pixels.

Parameters:
width
height

setSizeToViewportRatio(bool)

Automatically resize this dialog to the browser's viewport ratio (height and width) when the dialog is not maximized and the browser window is resized by the user.

Parameters:
bool: Boolean indicating if the non-maximized dialog should be resized to the browser's viewport ratio.

Since:: 2.0.3.5

setTitle(title)

Sets the title of the dialog box.

Parameters:
title

setWidth(width)

Sets the width of the dialog box (in pixels). The height of the dialog will automatically adjust to fit the content, but not move beyond 80% of the total window height.

Parameters:
width

show()

Prevent drag over the underlay.

showActionBar(show)

Shows or hides the action bar.

Parameters:
show: If true, the action bar will be shown. If false, the action bar is hidden.