phpDocumentor openbiz.bin.easy
[ class tree: openbiz.bin.easy ] [ index: openbiz.bin.easy ] [ all elements ]

Class: EasyFormWizard

Source Location: /easy/EasyFormWizard.php

Class EasyFormWizard

Class Overview

EasyFormWizard class - extension of BizForm to support wizard form

Located in /easy/EasyFormWizard.php [line 25]

MetaObject
   |
   --EasyForm
      |
      --EasyFormWizard
Author(s):
  • Rocky Swen
API Tags:
Access:  public

Information Tags:
Copyright:  Copyright (c) 2005-2009

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From EasyForm

EasyForm::$DATAFORMAT
EasyForm::$m_ActionPanel
EasyForm::$m_ActiveRecord
EasyForm::$m_CacheLifeTime
EasyForm::$m_CurrentPage
EasyForm::$m_DataObj
EasyForm::$m_DataObjName
EasyForm::$m_DataPanel
EasyForm::$m_DefaultForm
EasyForm::$m_Description
EasyForm::$m_EventName
EasyForm::$m_FixSearchRule
EasyForm::$m_FormType
EasyForm::$m_hasError
EasyForm::$m_Height
EasyForm::$m_jsClass
EasyForm::$m_MessageFile
EasyForm::$m_Messages
EasyForm::$m_NavPanel
EasyForm::$m_ParentFormName
EasyForm::$m_QueryStringParam
EasyForm::$m_Range
EasyForm::$m_RecordId
EasyForm::$m_RecordSet
EasyForm::$m_Referer
EasyForm::$m_RefreshData
EasyForm::$m_Resource
EasyForm::$m_SearchPanel
EasyForm::$m_SearchRule
EasyForm::$m_SearchRuleBindValues
EasyForm::$m_SubForms
EasyForm::$m_TemplateEngine
EasyForm::$m_TemplateFile
EasyForm::$m_Title
EasyForm::$m_TotalPages
EasyForm::$m_TotalRecords
EasyForm::$m_ValidateErrors
EasyForm::$m_Width

Inherited From MetaObject

MetaObject::$m_Access
MetaObject::$m_Class
MetaObject::$m_Name
MetaObject::$m_Package

Inherited From EasyForm

EasyForm::__construct()
Initialize BizForm with xml array
EasyForm::AutoSuggest()
Generate list for AutoSuggest listing. Formatted for simple of hidden inputs
EasyForm::CallService()
Call/Invoke service method, this EasyForm name is passed to the method
EasyForm::Cancel()
Cancel input and do page redirection
EasyForm::Close()
Close the popup window
EasyForm::CopyRecord()
Copy Record
EasyForm::DeleteRecord()
Delete Record NOTE: use redirectpage attr of eventhandler to redirect or redirect to previous page by default
EasyForm::EditRecord()
Edit Record NOTE: append fld:Id=$id to the redirect page url
EasyForm::FetchData()
Fetch single record
EasyForm::FetchDataSet()
Fetch record set
EasyForm::GetActiveRecord()
Get activeRecord
EasyForm::GetDataObj()
Get object instance of BizDataObj defined in it's metadata file
EasyForm::GetElement()
Get an element object
EasyForm::GetErrorElements()
Get error elements
EasyForm::GetErrorMessage()
Get error message
EasyForm::GetEventLogMsg()
Get event log message
EasyForm::GetMessage()
Get message, and translate it
EasyForm::GetNewRecord()
Get new record
EasyForm::GetOnEventElements()
Get on event elements
EasyForm::GetProperty()
Get object property
EasyForm::GetRedirectPage()
return redirect page and target array
EasyForm::GetSessionVars()
Get/Retrieve Session data of this object
EasyForm::GetSubForms()
Get sub form of this form
EasyForm::GetViewObject()
EasyForm::GotoPage()
Goto page specified by $page parameter, and ReRender
EasyForm::InsertRecord()
Insert new record
EasyForm::LoadPicker()
Popup a selection EasyForm in a dynamically generated EasyView
EasyForm::LoadPopForm()
Load pop form
EasyForm::NewRecord()
New record, be default, just redirect to the new record page
EasyForm::OutputAttrs()
Get output attributs as array
EasyForm::ProcessBDOException()
Handle the exception from DataObj method, report the error as an alert window
EasyForm::ProcessDataObjError()
Handle the error from DataObj method, report the error as an alert window
EasyForm::ProcessFormObjError()
Process error of form object
EasyForm::ProcessPostAction()
Process Post Action
EasyForm::ReadInputRecord()
Read user input data from UI
EasyForm::ReadInputs()
Read inputs
EasyForm::ReadMetadata()
Read array meta data, and store to meta object
EasyForm::RemoveRecord()
Remove the record out of the associate relationship
EasyForm::Render()
Render this form (return html content), called by EasyView's render method (called when form is loaded).
EasyForm::RenderContextMenu()
Render context menu code
EasyForm::RenderHTML()
Render html content of this form
EasyForm::RenderParent()
Render parent form
EasyForm::ReRender()
Rerender this form (form is rendered already) .
EasyForm::ReRenderSubForms()
Rerender sub forms who has dependecy on this form.
EasyForm::RunEventLog()
EasyForm::RunSearch()
Run Search
EasyForm::SaveRecord()
Save input and redirect page to a new view
EasyForm::SelectRecord()
Select Record
EasyForm::SetActiveRecord()
Set active record
EasyForm::SetClientScripts()
Set client scripts, auto add javascripts code to the page
EasyForm::SetDataObj()
Set data object (BizDataObj) with specified instant from parameter
EasyForm::SetFixSearchRule()
Set the dependent search rule of the bizform, this search rule will apply on its BizDataObj.
EasyForm::SetRequestParams()
Set request parameters
EasyForm::SetSessionVars()
Save object variable to session context
EasyForm::SetSubForms()
Set the sub forms of this form. This form is parent of other forms
EasyForm::SortRecord()
Sort Record, for list form
EasyForm::UpdateForm()
Update form controls
EasyForm::UpdateRecord()
Update record
EasyForm::ValidateForm()
EasyForm::_showForm()

Inherited From MetaObject

MetaObject::__construct()
MetaObject::AllowAccess()
MetaObject::GetProperty()
Get property
MetaObject::PrefixPackage()
Set Prefix Package
MetaObject::ReadMetaCollection()
Read metadata collection
MetaObject::ReadMetaData()
Read meta data

[ Top ]
Method Summary
void   Cancel()   Clean up the sessions of view and all forms
void   Commit()   Save wizard data of current+previous pages into database or other storage
void   DoCancel()   Cancel the wizard process
void   DoFinish()   Finish the wizard process
void   GetSessionVars()   Get/Retrieve Session data of this object
void   GoBack()   Go to previous wizard page
void   GoNext()   Go to next wizard page
@return   Render()   Render this form
void   SetSessionVars()   Save object variable to session context

[ Top ]
Properties
mixed   $m_DropSession = false [line 27]
API Tags:
Access:  protected


[ Top ]
Methods
Cancel  [line 179]

  void Cancel( )

Clean up the sessions of view and all forms


API Tags:
Access:  public


Redefinition of:
EasyForm::Cancel()
Cancel input and do page redirection

[ Top ]
Commit  [line 145]

  void Commit( )

Save wizard data of current+previous pages into database or other storage


API Tags:
Access:  public


[ Top ]
DoCancel  [line 131]

  void DoCancel( )

Cancel the wizard process


API Tags:
Access:  public


[ Top ]
DoFinish  [line 108]

  void DoFinish( )

Finish the wizard process


API Tags:
Access:  public


[ Top ]
GetSessionVars  [line 35]

  void GetSessionVars( SessionContext $sessionContext  )

Get/Retrieve Session data of this object

Parameters:
SessionContext   $sessionContext: 

API Tags:
Access:  public


Redefinition of:
EasyForm::GetSessionVars()
Get/Retrieve Session data of this object

[ Top ]
GoBack  [line 86]

  void GoBack( )

Go to previous wizard page


API Tags:
Access:  public


[ Top ]
GoNext  [line 62]

  void GoNext( [boolean $commit = false]  )

Go to next wizard page

Parameters:
boolean   $commit:  true if need to commit current form data

API Tags:
Access:  public


[ Top ]
Render  [line 190]

  @return Render( )

Render this form


API Tags:
Return:  string - HTML text of this form's read mode
Access:  public


Redefinition of:
EasyForm::Render()
Render this form (return html content), called by EasyView's render method (called when form is loaded).

[ Top ]
SetSessionVars  [line 48]

  void SetSessionVars( SessionContext $sessionContext  )

Save object variable to session context

Parameters:
SessionContext   $sessionContext: 

API Tags:
Access:  public


Redefinition of:
EasyForm::SetSessionVars()
Save object variable to session context

[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:02:50 -0800 by phpDocumentor 1.3.0RC3