Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
LinkAction Class Reference
Inheritance diagram for LinkAction:
AddSignoffFileLinkAction ApproveProofsLinkAction AuthorViewMetadataLinkAction BaseAddFileLinkAction DownloadAllLinkAction DownloadLibraryFileLinkAction EditEmailLinkAction FileLinkAction MonographlessCatalogEntryLinkAction NotifyLinkAction ReadSignoffHistoryLinkAction ReviewerViewMetadataLinkAction SelectFilesLinkAction SendReminderLinkAction SendThankYouLinkAction SignoffNotesLinkAction SubmissionEntryLinkAction SubmissionInfoCenterLinkAction UnconsiderReviewLinkAction ViewCompetingInterestGuidelinesLinkAction ViewReviewGuidelinesLinkAction

Public Member Functions

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

Public Attributes

 $_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.

Member Function Documentation

LinkAction::getActionRequest ( )

Get the action handler.

Returns
LinkActionRequest

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

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 113 of file LinkAction.inc.php.

References $_image.

LinkAction::getId ( )

Get the action id.

Returns
string

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

LinkAction::getImage ( )

Get the action image.

Returns
string

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

LinkAction::getTitle ( )

Get the localized action title.

Returns
string

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

LinkAction::getToolTip ( )

Get the localized tool tip.

Returns
string

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

LinkAction::LinkAction (   $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.

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

Member Data Documentation

LinkActionRequest LinkAction::$_actionRequest

The action to be taken when the link action is activated

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

string LinkAction::$_id

the id of the action

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

string LinkAction::$_image

The name of an icon for the action.

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

Referenced by getHoverTitle().

string LinkAction::$_title

The localized title of the action.

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

string LinkAction::$_toolTip

The localized tool tip of the action.

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


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