Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
LegacyLinkAction Class Reference

Public Member Functions

 getActOn ()
 
 getId ()
 
 getImage ()
 
 getLocalizedConfirmMessage ()
 
 getLocalizedTitle ()
 
 getMode ()
 
 getTitle ()
 
 getType ()
 
 getUrl ()
 
 LegacyLinkAction ($id, $mode, $type, $url, $title=null, $titleLocalized=null, $image=null, $confirmMessageLocalized=null, $actOn=null)
 
 setActOn ($actOn)
 
 setId ($id)
 
 setImage ($image)
 
 setLocalizedConfirmMessage ($confirmMessageLocalized)
 
 setMode ($mode)
 
 setTitle ($title)
 
 setTitleTranslated ($titleLocalized)
 
 setType ($type)
 
 setUrl ($url)
 

Detailed Description

Base class defining an action that can be performed within a Grid.

Definition at line 29 of file LegacyLinkAction.inc.php.

Member Function Documentation

LegacyLinkAction::getActOn ( )

Get the target object of the action (null if none configured).

Returns
string

Definition at line 229 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getId ( )

Get the action id.

Returns
string

Definition at line 100 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getImage ( )

Get the action image.

Returns
string

Definition at line 197 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getLocalizedConfirmMessage ( )

Get the locale key to display in the confirm dialog

Returns
string

Definition at line 213 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getLocalizedTitle ( )

Get the translated column title

Returns
string

Definition at line 180 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getMode ( )

Get the action mode.

Returns
integer

Definition at line 116 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getTitle ( )

Get the action title.

Returns
string

Definition at line 164 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getType ( )

Get the action type.

Returns
string

Definition at line 132 of file LegacyLinkAction.inc.php.

LegacyLinkAction::getUrl ( )

Get the action URL.

Returns
string

Definition at line 148 of file LegacyLinkAction.inc.php.

LegacyLinkAction::LegacyLinkAction (   $id,
  $mode,
  $type,
  $url,
  $title = null,
  $titleLocalized = null,
  $image = null,
  $confirmMessageLocalized = null,
  $actOn = null 
)

Constructor

Parameters
$idstring
$modeinteger one of LINK_ACTION_MODE_*
$typestring one of LINK_ACTION_TYPE_*
$urlstring
$titlestring (optional)
$titleLocalizedstring (optional)
$imagestring (optional)
$confirmMessageLocalizedstring (optional)
$actOnstring (optional) a specification of the target object to act on

Definition at line 76 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setActOn (   $actOn)

Specify the target object of the action (if any).

Parameters
$actOnstring

Definition at line 221 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setId (   $id)

Set the action id.

Parameters
$idstring

Definition at line 92 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setImage (   $image)

Set the action image.

Parameters
$imagestring

Definition at line 189 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setLocalizedConfirmMessage (   $confirmMessageLocalized)

Set the locale key to display in the confirm dialog

Parameters
$confirmMessageLocalizedstring

Definition at line 205 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setMode (   $mode)

Set the action mode.

Parameters
$modeinteger

Definition at line 108 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setTitle (   $title)

Set the action title.

Parameters
$titlestring

Definition at line 156 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setTitleTranslated (   $titleLocalized)

Set the column title (already translated)

Parameters
$titleLocalizedstring

Definition at line 172 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setType (   $type)

Set the action type.

Parameters
$typestring

Definition at line 124 of file LegacyLinkAction.inc.php.

LegacyLinkAction::setUrl (   $url)

Set the action URL.

Parameters
$urlstring

Definition at line 140 of file LegacyLinkAction.inc.php.


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