<?PHP

  require_once ('twIf/generic/editor.php');
  
  class twIf_Generic_Controllable_Editor extends twIf_Generic_Editor {
    // Internal storage for class-settings
    private $Classname = null;
    private $Caption = null;
    private $Introduction = null;
    private $Paging = null;
    private $ListParams = null;
    private $SortParams = null;
    private $Fields = null;
    private $Options = null;
    private $Highlight = null;
    private $EnableToggle = null;
    
    private $AllowCreate = null;
    private $AllowEdit = null;
    private $AllowDelete = null;
    
    private $EditorCaption = null;
    private $EditorFields = null;
    private $EditorFeedback = null;
    private $EditorMSGSaved = null;
    private $EditorMSGFailed = null;
    private $EditorMSGUnchanged = null;
    private $EditorSubmitCaption = null;
    private $CreatorCaption = null;
    private $CreatorClass = null;
    private $CreatorFields = null;
    private $CreatorParams = null;
    private $CreatorStrict = null;
    private $CreatorAuto = null;
    private $CreatorSubmitCaption = null;
    
    private $callbackCreate = null;
    private $callbackUpdate = null;
    
    private $Ready = false;
    private $ConstructorParams = null;
    
    // {{{ __construct
    /**
     * Prevent the class from beeing booted ;)
     * 
     * @access friendly
     * @return void
     **/
    function __construct () {
      $this->ConstructorParams = func_get_args ();
    }
    // }}}
    
    // {{{ boot
    /**
     * @access public
     * @return void
     **/
    public function boot () {
      if ($this->Ready)
        return;
      
      $this->Ready = true;
      
      parent::__construct ($this->ConstructorParams [0], $this->ConstructorParams [1], $this->ConstructorParams [2]);
    }
    // }}}
    
    // {{{ getDefinition
    /**
     * Make sure our class is ready
     * 
     * @access public
     * @return array
     **/
    public function getDefinition () {
      $this->boot ();
      
      return parent::getDefinition ();
    }
    // }}}
    
    // {{{ prepare
    /**
     * Make sure our class is ready
     * 
     * @access public
     * @return array 
     **/
    public function prepare () {
      $this->boot ();
      
      return parent::prepare ();
    }
    // }}}
    
    // {{{ setClassname
    /**
     * Set the name of the class we handle
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setClassname ($Value) {
      $this->Classname = $Value;
    }
    // }}}
    
    // {{{ setCaption
    /**
     * Set the caption for this widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setCaption ($Value) {
      $this->Caption = $Value;
    }
    // }}}
    
    // {{{ setIntroduction
    /**
     * Set the introduction for this widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setIntroduction ($Value) {
      $this->Introduction = $Value;
    }
    // }}}
    
    // {{{ setPaging
    /**
     * Decide wheter to enable paging in listing
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setPaging ($Value) {
      $this->Paging = $Value;
    }
    // }}}
    
    // {{{ setListParams
    /**
     * Set the parameters for item-listing
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setListParams ($Value) {
      $this->ListParams = $Value;
    }
    // }}}
    
    // {{{ setSortParams
    /**
     * Set parameters for sorting of items
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setSortParams ($Value) {
      $this->SortParams = $Value;
    }
    // }}}
    
    // {{{ setFields
    /**
     * Set the fields for listing
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setFields ($Value) {
      $this->Fields = $Value;
    }
    // }}}
    
    // {{{ setOptions
    /**
     * Set the options for items on the listing
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setOptions ($Value) {
      $this->Options = $Value;
    }
    // }}}
    
    // {{{ setHighlight
    /**
     * Set the filter for highlighting
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setHighlight ($Value) {
      $this->Highlight = $Value;
    }
    // }}}
    
    // {{{ setEnableToggle
    /**
     * Decide wheter to add the enable-toogle to listing
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setEnableToggle ($Value) {
      $this->EnableToggle = $Value;
    }
    // }}}
    
    // {{{ setAllowCreate
    /**
     * Decide wheter items may be created
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setAllowCreate ($Value) {
      $this->AllowCreate = $Value;
    }
    // }}}
    
    // {{{ setAllowEdit
    /**
     * Decide wheter items may be modified
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setAllowEdit ($Value) {
      $this->AllowEdit = $Value;
    }
    // }}}
    
    // {{{ setAllowDelete
    /**
     * Decide wheter items may be deleted
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setAllowDelete ($Value) {
      $this->AllowDelete = $Value;
    }
    // }}}
    
    // {{{ setEditorCaption
    /**
     * Set the caption for the editor-widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setEditorCaption ($Value) {
      $this->EditorCaption = $Value;
    }
    // }}}
    
    // {{{ setEditorFields
    /**
     * Set the field-definition for the object-editor
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setEditorFields ($Value) {
      $this->EditorFields = $Value;
    }
    // }}}
    
    // {{{ setGiveFeedback
    /**
     * Allow or disallow feedback on editor
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setGiveFeedback ($Value) {
      $this->EditorFeedback = $Value;
    }
    // }}}
    
    // {{{ setMessageSaved
    /**
     * Set feedback-message if changes were saved
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setMessageSaved ($Value) {
      $this->EditorMSGSaved = $Value;
    }
    // }}}
    
    // {{{ setMessageSaveFailed
    /**
     * Set feedback-message if changes could not be saved
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setMessageSaveFailed ($Value) {
      $this->EditorMSGFailed = $Value;
    }
    // }}}
    
    // {{{ setMessageNoChanges
    /**
     * Set feedback-message if nothing were changed
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setMessageNoChanges ($Value) {
      $this->EditorMSGUnchanged = $Value;
    }
    // }}}
    
    // {{{ setCreateCaption
    /**
     * Set the caption for the creator widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreateCaption ($Value) {
      $this->CreatorCaption = $Value;
    }
    // }}}
    
    // {{{ setCreateClass
    /**
     * Create another class as the defined one
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreateClass ($Value) {
      $this->CreatorClass = $Value;
    }
    // }}}
    
    // {{{ setCreateFields
    /**
     * Set the fields for the object-creator
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreateFields ($Value) {
      $this->CreatorFields = $Value;
    }
    // }}}
    
    // {{{ setCreateParams
    /**
     * Set parameters for constructor
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreateParams ($Value) {
      $this->CreatorParams = $Value;
    }
    // }}}
    
    // {{{ setCreateStrict
    /**
     * Decide if parameters for constructor should be strictly parsed
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreateStrict ($Value) {
      $this->CreatorStrict = $Value;
    }
    // }}}
    
    // {{{ setAutoCreate
    /**
     * Decide wheter to move directly to creator if there are no items on the listing
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setAutoCreate ($Value) {
      $this->CreatorAuto = $Value;
    }
    // }}}
    
    // {{{ setEditorSubmitCaption
    /**
     * Set caption for the submit-button on editor widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setEditorSubmitCaption ($Value) {
      $this->EditorSubmitCaption = $Value;
    }
    // }}}
    
    // {{{ setCreatorSubmitCaption
    /**
     * Set caption for the submit-button on creator widget
     * 
     * @param string $Value
     * 
     * @access public
     * @return void
     **/
    public function setCreatorSubmitCaption ($Value) {
      $this->CreatorSubmitCaption = $Value;
    }
    // }}}
    
    // {{{ setCallbackCreate
    /**
     * Set callback for function-call when an item was created
     * 
     * @param callback $CB
     * 
     * @access public
     * @return void
     **/
    public function setCallbackCreate ($CB) {
      $this->callbackCreate = $CB;
    }
    // }}}
    
    // {{{ setCallbackUpdate
    /**
     * Set callback for function-call when an item was updated
     * 
     * @param callback $CB
     * 
     * @access public
     * @return void
     **/
    public function setCallbackUpdate ($CB) {
      $this->callbackUpdate = $CB;
    }
    // }}}
    
    // {{{ getClass
    /**
     * Get the class used by this generic interface
     * 
     * @access protected
     * @return string
     */
    protected function getClass () {
      if ($this->Classname !== null)
        return $this->Classname;
      
      return parent::getClass ();
    }
    // }}}
    
    // {{{ getCaption
    /**
     * Get the caption of this page
     * 
     * @access protected
     * @return string
     **/
    protected function getCaption () {
      if ($this->Caption !== null)
        return $this->Caption;
      
      return parent::getCaption ();
    }
    // }}}
    
    // {{{ getIntroduction
    /**
     * Get introduction-text for this page
     * 
     * @access protected
     * @return mixed Array or String
     **/
    protected function getIntroduction () {
      if ($this->Introduction !== null)
        return $this->Introduction;
      
      return parent::getIntroduction ();
    }
    // }}}
    
    // {{{ getEnablePaging
    /**
     * Check wheter to enable paging
     * 
     * @access protected
     * @return bool 
     **/
    protected function getEnablePaging () {
      if ($this->Paging !== null)
        return $this->Paging;
      
      return parent::getEnablePaging ();
    }
    // }}}
    
    // {{{ getListParams
    /**
     * Get Parameters for listItems
     * 
     * @access protected
     * @return array
     **/
    protected function getListParams () {
      if ($this->ListParams !== null)
        return $this->ListParams;
      
      return parent::getListParams ();
    }  
    // }}}
    
    // {{{ getSortParams
    /**
     * Retrive parameters for sorting
     * 
     * @access protected
     * @return array
     **/
    protected function getSortParams () {
      if ($this->SortParams !== null)
        return $this->SortParams;
      
      return parent::getSortParams ();
    }
    // }}}
    
    // {{{ getFields
    /**
     * Get Field-Definition for listing
     * 
     * @access protected
     * @return array
     **/
    protected function getFields () {
      if ($this->Fields !== null)
        return $this->Fields;
      
      return parent::getFields ();
    }
    // }}}
    
    // {{{ getOptions
    /**
     * Get Options for Listing
     * 
     * @access public
     * @return array
     **/
    public function getOptions () {
      $this->boot ();
      
      if ($this->Options !== null)
        return $this->Options;
      
      return parent::getOptions ();
    }
    // }}}
    
    // {{{ getHighlight
    /**
     * Get rules for element-highlightning
     * 
     * @access protected
     * @return array
     **/
    protected function getHighlight () {
      if ($this->Highlight !== null)
        return $this->Highlight;
      
      return parent::getHighlight ();
    }
    // }}}
    
    // {{{ getEnableToggle
    /**
     * Check wheter to enable toggle in listing
     * 
     * @access protected
     * @return bool
     */
    protected function getEnableToggle () {
      if ($this->EnableToggle !== null)
        return $this->EnableToggle;
      
      return parent::getEnableToggle ();
    }
    // }}}
    
    // {{{ getEditorCaption
    /**
     * Get the caption for editor-page
     * 
     * @access public
     * @return string
     **/
    public function getEditorCaption () {
      if ($this->EditorCaption !== null)
        return $this->EditorCaption;
      
      return parent::getEditorCaption ();
    }
    // }}}
    
    // {{{ getEditorFields
    /**
     * Get field-definition for editor
     * 
     * @access protected
     * @return array
     **/
    protected function getEditorFields () {
      if ($this->EditorFields !== null)
        return $this->EditorFields;
        
      return parent::getEditorFields ();
    }
    // }}}
    
    // {{{ giveFeedback 
    /**
     * Determine wheter the editor-widget should output a feedback or not
     * 
     * @access protected
     * @return bool
     **/
    protected function giveFeedback () {
      if ($this->EditorFeedback !== null)
        return $this->EditorFeedback;
        
      return parent::giveFeedback ();
    }
    // }}}
    
    // {{{ getMessageSaved
    /**
     * Which message to output when an object was saved
     *  
     * @access protected
     * @return string
     **/
    protected function getMessageSaved () {
      if ($this->EditorMSGSaved !== null)
        return $this->EditorMSGSaved;
        
      return parent::getMessageSaved ();
    }
    // }}}
    
    // {{{ getMessageSaveFailed
    /**
     * Which message to output whenver save failed
     * 
     * @access protected
     * @return string
     **/
    protected function getMessageSaveFailed () {
      if ($this->EditorMSGFailed !== null)
        return $this->EditorMSGFailed;
        
      return parent::getMessageSaveFailed ();
    }
    // }}}
    
    // {{{ getMessageNoChanges
    /**
     * Which message to output whenever no changes where made 
     * 
     * @access protected
     * @return string
     **/
    protected function getMessageNoChanges () {
      if ($this->EditorMSGUnchanged !== null)
        return $this->EditorMSGUnchanged;
        
      return parent::getMessageNoChanges ();
    }
    // }}}
    
    // {{{ getCreateCaption
    /**
     * Get the caption for new object-creation
     * 
     * @access public
     * @return string
     **/
    public function getCreateCaption () {
      if ($this->CreatorCaption !== null)
        return $this->CreatorCaption;
        
      return parent::getCreateCaption ();
    }
    // }}}
    
    // {{{ getCreateClass
    /**
     * Retrive the name of the class we use to create an item
     * 
     * @access public
     * @return string
     **/
    protected function getCreateClass () {
      if ($this->CreatorClass !== null)
        return $this->CreatorClass;
        
      return parent::getCreateClass ();
    }
    // }}}
    
    // {{{ getCreateFields
    /**
     * @access protected
     * @return array
     **/
    protected function getCreateFields () {
      if ($this->CreatorFields !== null)   
        return $this->CreatorFields;
        
      return parent::getCreateFields ();
    }
    // }}}
    
    // {{{ getCreateParams
    /** 
     * Determine which params pass to constructor of our class
     *    
     * @access protected
     * @return array   
     **/
    protected function getCreateParams () {
      if ($this->CreatorParams !== null)   
        return $this->CreatorParams;
        
      return parent::getCreateParams ();
    }
    // }}}
    
    // {{{ getCreateStrict
    /**
     * Check wheter to parse Create-parameters in strict mode
     * 
     * @access protected
     * @return bool
     **/
    protected function getCreateStrict () {
      if ($this->CreatorStrict !== null)   
        return $this->CreatorStrict;
        
      return parent::getCreateStrict ();
    }
    // }}}
    
    // {{{ getAutoCreate
    /**
     * Automatically switch to creator-mode when not items are found
     * 
     * @access protected
     * @return bool
     **/
    protected function getAutoCreate () {
      if ($this->CreatorAuto !== null)   
        return $this->CreatorAuto;
        
      return parent::getAutoCreate ();
    }
    // }}}
    
    // {{{ getSubmitCaption 
    /**
     * Retrive the caption of our submit-button
     *  
     * @access protected
     * @return string   
     **/
    protected function getSubmitCaption () {
      if ($this->onEditor ())
        $Value = $this->EditorSubmitCaption;
      elseif ($this->onCreator ())
        $Value = $this->CreatorSubmitCaption;
      
      if ($Value !== null)
        return $Value;
      
      return parent::getSubmitCaption ();
    }
    // }}}
    
    // {{{ getAllowEdit
    /**
     * Check if we may edit elements
     *    
     * @access protected
     * @return bool
     */
    protected function getAllowEdit () {
      if ($this->AllowEdit !== null)
        return $this->AllowEdit;
      
      return parent::getAllowEdit ();
    }
    // }}}
       
    // {{{ getAllowCreate
    /**
     * Check if we may create elements
     *    
     * @access protected
     * @return bool
     */
    protected function getAllowCreate () {
      if ($this->AllowCreate !== null)
        return $this->AllowCreate;
      
      return parent::getAllowCreate ();
    }
    // }}}
    
    // {{{ getAllowDelete
    /**
     * Check wheter to allow removal of items
     * 
     * @access protected
     * @return bool
     **/
    protected function getAllowDelete () {
      if ($this->AllowDelete !== null)
        return $this->AllowDelete;
      
      return parent::getAllowDelete ();
    }  
    // }}}
    
    // {{{ callbackCreate
    /**
     * Callback for Item-Creation
     *
     * @param object $Handle The object that was created
     * 
     * @access public
     * @return void
     **/
    protected function callbackCreate ($Handle) {
      if (is_callable ($this->callbackCreate))
        return call_user_func ($this->callbackCreate, $Handle);
    }
    // }}}
    
    // {{{ callbackUpdate
    /**
     * Callback for Item-Updates
     * 
     * @param object $Handle The object which was updated   
     * 
     * @access protected
     * @return void
     **/
    protected function callbackUpdate ($Handle) {
      if (is_callable ($this->callbackUpdate))
        return call_user_func ($this->callbackUpdate, $Handle);
    }
    // }}}

  }

?>