Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This client-side class allows operations with provides methods that manage modal objects (, such as pop-ups)up windows.

s_modal


This method instantiates Use this global object to instantiate a new SimpleModal object. Use it in client scripts for the widgets or the UI Actions.

renderPageTemplate (portalPathName, pagePathName)


This method displays Use this method to display the content in a modal window according to the set of widgets the portal page template contains.

Parameter(s)Parameters:

NameTypeMandatoryDefault
Value
value
portalPathNameStringYN
pagePathNameStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlerenderPageTemplate()
s_modal.renderPageTemplate('portal', 'page');

renderPagePathTemplate (pagePathName, portalPathName)


This method displays Use this method to display the content in a modal window according to the set of widgets the portal page template contains. This method is similar to the previous one but has another sequence of parameters. 

Parameter(s):

NameTypeMandatoryDefault Valuevalue
pagePathName  StringYN
portalPathNameStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlerenderPagePathTemplate()
s_modal.renderPagePathTemplate('page', 'portal');

renderTemplate(template, style)


This Use this method renders to render the UI page in the modal window with the HTML template and styles specified.

Parameter(s)Parameters:

NameTypeMandatoryDefault
Value
value
htmlStringYN
styleStringN''

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlerenderTemplate()
s_modal.renderTemplate('<div><h1>Hello</h1></div>', 'h1 {color: red}; div {margin: 20px}');

setShow(isShow)


Use this method to specify whether to show or to hide the modal object when calling the methodor hide a modal window.

Parameter(s):

NameTypeMandatoryDefault
Value
value
isShowBooleanNtrue

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlesetShow()
s_modal.setShow(false);

setTitle(title)


Use this method to define the title of the modal objectwindow.

Parameter(s):

NameTypeMandatoryDefault
Value
value
titleStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlesetTitle()
s_modal.setTitle('Merging');

setWidth(width)


Use this method to define the width of the modal object in window in pixels.

Parameter(s):

NameTypeMandatoryDefault
Value
value
widthIntegerYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlesetWidth()
s_modal.setWidth(500);


Table of Contents
absoluteUrltrue
classfixedPosition