<?PHP

  require_once ('twIf/generic/listing.php');
  
  class twIf_Generic_Controllable_Listing extends twIf_Generic_Listing {
    // 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 $AllowDelete = null;
    private $RemoveCaption = null;
    private $RemoveSuccess = null;
    private $RemoveDelayed = null;
    private $RemoveFailed = 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;
    }
    // }}}
    
    // {{{ setAllowDelete
    /**
     * Decide wheter items may be deleted
     * 
     * @param bool $Value
     * 
     * @access public
     * @return void
     **/
    public function setAllowDelete ($Value) {
      $this->AllowDelete = $Value;
    }
    // }}}
    
    // {{{ 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 () {
      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 ();
    }
    // }}}
    
    // {{{ 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 ();
    }
    // }}}
    
    // {{{ setRemoveCaption
    /**
     * Set the caption for the remove-option
     * 
     * @param string $Caption
     * 
     * @access public
     * @return void
     **/
    public function setRemoveCaption ($Caption) {
      $this->RemoveCaption = $Caption;
    }
    // }}}
    
    // {{{ getRemoveCaption
    /**
     * Retrive the caption for the remove-option
     * 
     * @access protected
     * @return string
     **/
    protected function getRemoveCaption () {
      if ($this->RemoveCaption !== null)
        return $this->RemoveCaption;
      
      return parent::getRemoveCaption ();
    }
    // }}}
    
    // {{{ setRemoveSuccess
    /**
     * Set the message when a record was removed
     * 
     * @param string $Caption
     * 
     * @access public
     * @return void
     **/
    public function setRemoveSuccess ($Caption) {
      $this->RemoveSuccess = $Caption;
    }
    // }}}
    
    // {{{ getRemoveSuccess
    /**
     * Retrive message when record was removed
     * 
     * @access protected
     * @return string
     **/
    protected function getRemoveSuccess () {
      if ($this->RemoveSuccess !== null)
        return $this->RemoveSuccess;
      
      return parent::getRemoveSuccess ();
    }
    // }}}
     
    // {{{ setRemoveDelayed
    /**
     * Set the message when removal of a record was delayed
     * 
     * @param string $Caption
     * 
     * @access public
     * @return void
     **/
    public function setRemoveDelayed ($Caption) {
      $this->RemoveDelayed = $Caption;
    }
    // }}}
    
    // {{{ getRemoveDelayed
    /**
     * Retrive message when removal of a record was delayed
     * 
     * @access protected
     * @return string
     **/
    protected function getRemoveDelayed () {
      if ($this->RemoveDelayed !== null)
        return $this->RemoveDelayed;
      
      return parent::getRemoveDelayed ();
    }
    // }}}
     
    // {{{ setRemoveFailed
    /**
     * Set the message when a record could not be removed
     * 
     * @param string $Caption
     * 
     * @access public
     * @return void
     **/
    public function setRemoveFailed ($Caption) {
      $this->RemoveFailed = $Caption;
    }
    // }}}
    
    // {{{ getRemoveFailed
    /**
     * Retrive message when a record could not be removed
     * 
     * @access protected
     * @return string
     **/
    protected function getRemoveFailed () {
      if ($this->RemoveFailed !== null)
        return $this->RemoveFailed;
      
      return parent::getRemoveFailed ();
    }
    // }}}
  }

?>