Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
GridBodyElement Class Reference
Inheritance diagram for GridBodyElement:
GridColumn GridRow BaseSignoffStatusColumn FileGenreGridColumn FileNameGridColumn FileSignoffGridColumn ItemSelectionGridColumn ListbuilderGridColumn UploaderUserGroupGridColumn AddThisStatisticsGridRow AnnouncementGridRow AnnouncementTypeGridRow ApprovedProofFilesGridRow CategoryGridRow ContextGridRow ContributorGridRow EventLogGridRow GenreGridRow GridCategoryRow IdentificationCodeGridRow LanguageGridRow LibraryFileGridRow ListbuilderGridRow MarketsGridRow NotificationsGridRow PKPAuthorGridRow PKPCitationGridRow PKPFilterGridRow PKPPluginGridRow PKPPreparedEmailsGridRow PublicationDateGridRow PublicationFormatGridRow RepresentativesGridRow ReviewerGridRow ReviewerSelectGridRow SalesRightsGridRow SeriesGridRow SignoffGridRow SocialMediaGridRow SponsorGridRow SpotlightsGridRow StageParticipantGridRow SubmissionChecklistGridRow SubmissionFilesGridRow UserGridRow UserGroupGridRow

Public Member Functions

 addFlag ($flag, $value=true)
 
getCellProvider ()
 
 getFlag ($flag)
 
 getFlags ()
 
 getId ()
 
 GridBodyElement ($id= '', $cellProvider=null, $flags=array())
 
 hasFlag ($flag)
 
 setCellProvider (&$cellProvider)
 
 setId ($id)
 

Public Attributes

 $_cellProvider
 
 $_flags
 
 $_id
 

Detailed Description

Base class for grid body elements.

Definition at line 16 of file GridBodyElement.inc.php.

Member Function Documentation

GridBodyElement::addFlag (   $flag,
  $value = true 
)

Add a layout flag

Parameters
$flagstring
$valuemixed optional

Definition at line 102 of file GridBodyElement.inc.php.

& GridBodyElement::getCellProvider ( )

Get the cell provider

Returns
GridCellProvider

Definition at line 110 of file GridBodyElement.inc.php.

GridBodyElement::getFlag (   $flag)

Get a single layout flag

Parameters
$flagstring
Returns
mixed

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

GridBodyElement::getFlags ( )

Get all layout flags

Returns
array

Definition at line 73 of file GridBodyElement.inc.php.

GridBodyElement::GridBodyElement (   $id = '',
  $cellProvider = null,
  $flags = array() 
)

Constructor

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

GridBodyElement::hasFlag (   $flag)

Check whether a layout flag is set to true.

Parameters
$flagstring
Returns
boolean

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

GridBodyElement::setCellProvider ( $cellProvider)

Set the cell provider

Parameters
$cellProviderGridCellProvider

Definition at line 118 of file GridBodyElement.inc.php.

GridBodyElement::setId (   $id)

Set the element id

Parameters
$idstring

Definition at line 65 of file GridBodyElement.inc.php.

Referenced by LibraryFileGridCategoryRow\initialize().

Member Data Documentation

GridCellProvider GridBodyElement::$_cellProvider

a cell provider for cells inside this element

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

array GridBodyElement::$_flags

flags that can be set by the handler to trigger layout options in the element or in cells inside of it.

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

string GridBodyElement::$_id

identifier of the element instance - must be unique among all instances within a grid.

Definition at line 24 of file GridBodyElement.inc.php.


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