Open Journal Systems  3.3.0
LinkAction Class Reference
Inheritance diagram for LinkAction:
BaseAddFileLinkAction DownloadAllLinkAction DownloadLibraryFileLinkAction EmailLinkAction FileLinkAction NotifyLinkAction ReviewerViewMetadataLinkAction ReviewNotesLinkAction SelectFilesLinkAction SendReminderLinkAction SendThankYouLinkAction SubmissionInfoCenterLinkAction SubmissionLibraryLinkAction UnconsiderReviewLinkAction ViewCompetingInterestGuidelinesLinkAction ViewReviewGuidelinesLinkAction

Public Member Functions

 __construct ($id, $actionRequest, $title=null, $image=null, $toolTip=null)
 
 getActionRequest ()
 
 getHoverTitle ()
 
 getId ()
 
 getImage ()
 
 getTitle ()
 
 getToolTip ()
 
 setTitle ($title)
 

Data Fields

 $_actionRequest
 
 $_id
 
 $_image
 
 $_title
 
 $_toolTip
 

Detailed Description

Base class defining an action that can be performed by the user in the user interface.

Definition at line 22 of file LinkAction.inc.php.

Constructor & Destructor Documentation

◆ __construct()

LinkAction::__construct (   $id,
  $actionRequest,
  $title = null,
  $image = null,
  $toolTip = null 
)

Constructor

Parameters
$idstring
$actionRequestLinkActionRequest The action to be taken when the link action is activated.
$titlestring (optional) The localized title of the action.
$imagestring (optional) The name of an icon for the action.
$toolTipstring (optional) A localized tool tip to display when hovering over the link action.

Reimplemented in FileLinkAction.

Definition at line 63 of file LinkAction.inc.php.

References HookRegistry\call().

Member Function Documentation

◆ getActionRequest()

LinkAction::getActionRequest ( )

Get the action handler.

Returns
LinkActionRequest

Definition at line 89 of file LinkAction.inc.php.

References $_actionRequest.

◆ getHoverTitle()

LinkAction::getHoverTitle ( )

Get a title for display when a user hovers over the link action. Default to the regular title if it is set.

Returns
string

Definition at line 122 of file LinkAction.inc.php.

References getId(), and getToolTip().

◆ getId()

LinkAction::getId ( )

Get the action id.

Returns
string

Definition at line 81 of file LinkAction.inc.php.

References $_id.

Referenced by getHoverTitle().

◆ getImage()

LinkAction::getImage ( )

Get the action image.

Returns
string

Definition at line 137 of file LinkAction.inc.php.

References $_image.

◆ getTitle()

LinkAction::getTitle ( )

Get the localized action title.

Returns
string

Definition at line 97 of file LinkAction.inc.php.

References $_title.

◆ getToolTip()

LinkAction::getToolTip ( )

Get the localized tool tip.

Returns
string

Definition at line 113 of file LinkAction.inc.php.

References $_toolTip.

Referenced by getHoverTitle().

◆ setTitle()

LinkAction::setTitle (   $title)

Set the localized action title.

Returns
string

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

Field Documentation

◆ $_actionRequest

LinkActionRequest LinkAction::$_actionRequest

The action to be taken when the link action is activated

Definition at line 33 of file LinkAction.inc.php.

Referenced by getActionRequest().

◆ $_id

string LinkAction::$_id

the id of the action

Definition at line 27 of file LinkAction.inc.php.

Referenced by getId().

◆ $_image

string LinkAction::$_image

The name of an icon for the action.

Definition at line 51 of file LinkAction.inc.php.

Referenced by getImage().

◆ $_title

string LinkAction::$_title

The localized title of the action.

Definition at line 39 of file LinkAction.inc.php.

Referenced by getTitle().

◆ $_toolTip

string LinkAction::$_toolTip

The localized tool tip of the action.

Definition at line 45 of file LinkAction.inc.php.

Referenced by getToolTip().


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