ImportWizardView Class Reference

Inheritance diagram for ImportWizardView:
EditView DetailsView ModelView ConfigurableMetadataView MetadataView View ImportWizardCreateUpdateModelsCompleteView ImportWizardDataAnalysisCompleteView ImportWizardImportRulesView ImportWizardMappingView ImportWizardSetModelPermissionsView ImportWizardUploadFileView

Public Member Functions

 __construct ($controllerId, $moduleId, ImportWizardForm $model, $title=null)
 isUniqueToAPage ()

Protected Member Functions

 renderActionElementBar ($renderedInForm)
 renderActionLinksContent ()
 renderPreviousPageLinkContent ()
 getPreviousPageLinkContentByControllerAction ($action)
 renderPreviousPageLinkLabel ()
 renderNextPageLinkContent ()
 renderNextPageLinkLabel ()

Static Protected Member Functions

static assertMetadataIsValid (array $metadata)

Protected Attributes

 $cssClasses = array( 'AdministrativeArea')
 $disableFloatOnToolbar = true

Detailed Description

Base View for import wizard user interfaces. Supports previous and next links in the bottom of each view.

Definition at line 40 of file ImportWizardView.php.


Constructor & Destructor Documentation

__construct ( controllerId,
moduleId,
ImportWizardForm model,
title = null 
)
Parameters:
string $controllerId
string $moduleId
ImportWizardForm $model
null|string $title

Definition at line 52 of file ImportWizardView.php.


Member Function Documentation

renderActionElementBar ( renderedInForm  )  [protected]

Render a toolbar above the form layout. This includes buttons and/or links to go to different views or process actions such as save or delete

Parameters:
boolean $renderedInForm
Returns:
A string containing the element's content.

Reimplemented from MetadataView.

Definition at line 63 of file ImportWizardView.php.

renderActionLinksContent (  )  [protected]

Given a form, render the content for the action links at the bottom of the view and return the content as a string.

Parameters:
object $form

Reimplemented in ImportWizardDataAnalysisCompleteView.

Definition at line 74 of file ImportWizardView.php.

renderPreviousPageLinkContent (  )  [protected]

Override if the view should show a previous link.

Reimplemented in ImportWizardDataAnalysisCompleteView, ImportWizardMappingView, ImportWizardSetModelPermissionsView, and ImportWizardUploadFileView.

Definition at line 93 of file ImportWizardView.php.

renderNextPageLinkContent (  )  [protected]

Override if the view should show a next link.

Reimplemented in ImportWizardCreateUpdateModelsCompleteView, and ImportWizardDataAnalysisCompleteView.

Definition at line 114 of file ImportWizardView.php.

static assertMetadataIsValid ( array $  metadata  )  [static, protected]

There are no special requirements for this view's metadata.

Reimplemented from DetailsView.

Definition at line 127 of file ImportWizardView.php.

isUniqueToAPage (  ) 

Tells View that it can render the extending class' divs with and id matching their name. Must be overridden to return false in extending classes that can be rendered multiple times within a page to avoid generating a page with non-unique ids which will fail XHtml validation. For those it will render a class attribute with their name.

Reimplemented from View.

Definition at line 131 of file ImportWizardView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Jun 26 07:10:26 2017