Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Modal Class Reference
Inheritance diagram for Modal:
LinkActionRequest AjaxModal ConfirmationModal AjaxLegacyPluginModal WizardModal JsEventConfirmationModal RedirectConfirmationModal RemoteActionConfirmationModal

Public Member Functions

 getCanClose ()
 
 getJSLinkActionRequest ()
 
 getLocalizedOptions ()
 
 getTitle ()
 
 getTitleIcon ()
 
 getWidth ()
 
 Modal ($title=null, $titleIcon=null, $canClose=true, $width=MODAL_WIDTH_DEFAULT)
 
- Public Member Functions inherited from LinkActionRequest
 getJSLinkActionRequest ()
 
 getLocalizedOptions ()
 
 LinkActionRequest ()
 

Public Attributes

 $_canClose
 
 $_title
 
 $_titleIcon
 
 $_width
 

Detailed Description

Abstract base class for all modal dialogs.

Definition at line 21 of file Modal.inc.php.

Member Function Documentation

Modal::getCanClose ( )

Whether the modal has a close icon in the title bar.

Returns
boolean

Definition at line 87 of file Modal.inc.php.

Modal::getJSLinkActionRequest ( )
See Also
LinkActionRequest::getJSLinkActionRequest()

Definition at line 105 of file Modal.inc.php.

Modal::getLocalizedOptions ( )
See Also
LinkActionRequest::getLocalizedOptions()

Definition at line 112 of file Modal.inc.php.

Modal::getTitle ( )

Get the localized title.

Returns
string

Definition at line 71 of file Modal.inc.php.

Modal::getTitleIcon ( )

Get the title bar icon.

Returns
string

Definition at line 79 of file Modal.inc.php.

Modal::getWidth ( )

Get the width of the modal.

Definition at line 94 of file Modal.inc.php.

Modal::Modal (   $title = null,
  $titleIcon = null,
  $canClose = true,
  $width = MODAL_WIDTH_DEFAULT 
)

Constructor

Parameters
$titlestring (optional) The localized modal title.
$titleIconstring (optional) The icon to be used in the modal title bar.
$canCloseboolean (optional) Whether the modal will have a close button.
$widthint (optional) Override the default width of 'auto' for confirmation modals. Useful for modals that display large blocks of text.

Definition at line 55 of file Modal.inc.php.

Member Data Documentation

boolean Modal::$_canClose

Whether the modal has a close icon in the title bar.

Definition at line 38 of file Modal.inc.php.

string Modal::$_title

The localized title of the modal.

Definition at line 26 of file Modal.inc.php.

string Modal::$_titleIcon

The icon to be displayed in the title bar.

Definition at line 32 of file Modal.inc.php.

string Modal::$_width

The width of the modal

Definition at line 44 of file Modal.inc.php.


The documentation for this class was generated from the following file: