Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Modal Class Reference
Inheritance diagram for Modal:
LinkActionRequest AjaxModal ConfirmationModal AjaxLegacyPluginModal WizardModal 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 ()
 

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 75 of file Modal.inc.php.

Referenced by getLocalizedOptions().

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

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

Modal::getLocalizedOptions ( )
Modal::getTitle ( )

Get the localized title.

Returns
string

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

Referenced by getLocalizedOptions().

Modal::getTitleIcon ( )

Get the title bar icon.

Returns
string

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

Referenced by getLocalizedOptions().

Modal::getWidth ( )

Get the width of the modal.

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

Referenced by getLocalizedOptions().

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 43 of file Modal.inc.php.


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