Subversion-Projekte lars-tiefland.prado

<?php

/**

 * TDataGridPagerStyle class file.

 *

 * @author Qiang Xue <qiang.xue@gmail.com>

 * @link http://www.pradosoft.com/

 * @copyright Copyright © 2005-2008 PradoSoft

 * @license http://www.pradosoft.com/license/

 * @version $Id: TDataGridPagerStyle.php 2541 2008-10-21 15:05:13Z qiang.xue $

 * @package System.Web.UI.WebControls

 */

Prado::using('System.Web.UI.WebControls.TDataGrid');

/**

 * TDataGridPagerStyle class.

 *

 * TDataGridPagerStyle specifies the styles available for a datagrid pager.

 *

 * @author Qiang Xue <qiang.xue@gmail.com>

 * @version $Id: TDataGridPagerStyle.php 2541 2008-10-21 15:05:13Z qiang.xue $

 * @package System.Web.UI.WebControls

 * @since 3.0

 */

class TDataGridPagerStyle extends TPanelStyle

{

	private $_mode=null;

	private $_nextText=null;

	private $_prevText=null;

	private $_buttonCount=null;

	private $_position=null;

	private $_visible=null;

	private $_buttonType=null;

	/**

	 * @return TDataGridPagerMode pager mode. Defaults to TDataGridPagerMode::NextPrev.

	 */

	public function getMode()

	{

		return $this->_mode===null?TDataGridPagerMode::NextPrev : $this->_mode;

	}

	/**

	 * @param TDataGridPagerMode pager mode.

	 */

	public function setMode($value)

	{

		$this->_mode=TPropertyValue::ensureEnum($value,'TDataGridPagerMode');

	}

	/**

	 * @return TDataGridPagerButtonType the type of command button. Defaults to TDataGridPagerButtonType::LinkButton.

	 */

	public function getButtonType()

	{

		return $this->_buttonType===null?TDataGridPagerButtonType::LinkButton:$this->_buttonType;

	}

	/**

	 * @param TDataGridPagerButtonType the type of command button

	 */

	public function setButtonType($value)

	{

		$this->_buttonType=TPropertyValue::ensureEnum($value,'TDataGridPagerButtonType');

	}

	/**

	 * @return string text for the next page button. Defaults to '>'.

	 */

	public function getNextPageText()

	{

		return $this->_nextText===null?'>':$this->_nextText;

	}

	/**

	 * @param string text for the next page button.

	 */

	public function setNextPageText($value)

	{

		$this->_nextText=$value;

	}

	/**

	 * @return string text for the previous page button. Defaults to '<'.

	 */

	public function getPrevPageText()

	{

		return $this->_prevText===null?'<':$this->_prevText;

	}

	/**

	 * @param string text for the next page button.

	 */

	public function setPrevPageText($value)

	{

		$this->_prevText=$value;

	}

	/**

	 * @return integer maximum number of pager buttons to be displayed. Defaults to 10.

	 */

	public function getPageButtonCount()

	{

		return $this->_buttonCount===null?10:$this->_buttonCount;

	}

	/**

	 * @param integer maximum number of pager buttons to be displayed

	 * @throws TInvalidDataValueException if the value is less than 1.

	 */

	public function setPageButtonCount($value)

	{

		if(($value=TPropertyValue::ensureInteger($value))<1)

			throw new TInvalidDataValueException('datagridpagerstyle_pagebuttoncount_invalid');

		$this->_buttonCount=$value;

	}

	/**

	 * @return TDataGridPagerPosition where the pager is to be displayed. Defaults to TDataGridPagerPosition::Bottom.

	 */

	public function getPosition()

	{

		return $this->_position===null?TDataGridPagerPosition::Bottom:$this->_position;

	}

	/**

	 * @param TDataGridPagerPosition where the pager is to be displayed.

	 */

	public function setPosition($value)

	{

		$this->_position=TPropertyValue::ensureEnum($value,'TDataGridPagerPosition');

	}

	/**

	 * @return boolean whether the pager is visible. Defaults to true.

	 */

	public function getVisible()

	{

		return $this->_visible===null?true:$this->_visible;

	}

	/**

	 * @param boolean whether the pager is visible.

	 */

	public function setVisible($value)

	{

		$this->_visible=TPropertyValue::ensureBoolean($value);

	}

	/**

	 * Resets the style to the original empty state.

	 */

	public function reset()

	{

		parent::reset();

		$this->_visible=null;

		$this->_position=null;

		$this->_buttonCount=null;

		$this->_prevText=null;

		$this->_nextText=null;

		$this->_mode=null;

		$this->_buttonType=null;

	}

	/**

	 * Copies the fields in a new style to this style.

	 * If a style field is set in the new style, the corresponding field

	 * in this style will be overwritten.

	 * @param TStyle the new style

	 */

	public function copyFrom($style)

	{

		parent::copyFrom($style);

		if($style instanceof TDataGridPagerStyle)

		{

			if($style->_visible!==null)

				$this->_visible=$style->_visible;

			if($style->_position!==null)

				$this->_position=$style->_position;

			if($style->_buttonCount!==null)

				$this->_buttonCount=$style->_buttonCount;

			if($style->_prevText!==null)

				$this->_prevText=$style->_prevText;

			if($style->_nextText!==null)

				$this->_nextText=$style->_nextText;

			if($style->_mode!==null)

				$this->_mode=$style->_mode;

			if($style->_buttonType!==null)

				$this->_buttonType=$style->_buttonType;

		}

	}

	/**

	 * Merges the style with a new one.

	 * If a style field is not set in this style, it will be overwritten by

	 * the new one.

	 * @param TStyle the new style

	 */

	public function mergeWith($style)

	{

		parent::mergeWith($style);

		if($style instanceof TDataGridPagerStyle)

		{

			if($this->_visible===null)

				$this->_visible=$style->_visible;

			if($this->_position===null)

				$this->_position=$style->_position;

			if($this->_buttonCount===null)

				$this->_buttonCount=$style->_buttonCount;

			if($this->_prevText===null)

				$this->_prevText=$style->_prevText;

			if($this->_nextText===null)

				$this->_nextText=$style->_nextText;

			if($this->_mode===null)

				$this->_mode=$style->_mode;

			if($this->_buttonType===null)

				$this->_buttonType=$style->_buttonType;

		}

	}

}