<?PHP

  require_once ('twIf/generic/listbox.php');
  
  class twIf_Generic_Controllable_Listbox extends twIf_Generic_Listbox {
    // 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 $Highlight = null;
    
    // {{{ 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;
    }
    // }}}
    
    // {{{ setHighlight
    /**
     * Set the filter for highlighting
     * 
     * @param array $Value
     * 
     * @access public
     * @return void
     **/
    public function setHighlight ($Value) {
      $this->Highlight = $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 ();
    }
    // }}}
    
    // {{{ getHighlight
    /**
     * Get rules for element-highlightning
     * 
     * @access protected
     * @return array
     */
    protected function getHighlight () {
      if ($this->Highlight !== null)
        return $this->Highlight;
      
      return parent::getHighlight ();
    }
    // }}}
  }

?>