Class TDataGridPagerStyle

Description

TDataGridPagerStyle class.

TDataGridPagerStyle specifies the styles available for a datagrid pager.

  • author: Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: TDataGridPagerStyle.php 2996 2011-06-20 15:24:57Z ctrlaltca@gmail.com $
  • since: 3.0

Located in /Web/UI/WebControls/TDataGridPagerStyle.php (line 25)

TComponent
   |
   --TStyle
      |
      --TPanelStyle
         |
         --TDataGridPagerStyle
Method Summary
void copyFrom (TStyle $style)
string getFirstPageText ()
string getLastPageText ()
string getNextPageText ()
integer getPageButtonCount ()
string getPrevPageText ()
boolean getVisible ()
void mergeWith (TStyle $style)
void reset ()
void setFirstPageText (string $value)
void setLastPageText (string $value)
void setMode (TDataGridPagerMode $value)
void setNextPageText (string $value)
void setPageButtonCount (integer $value)
void setPrevPageText (string $value)
void setVisible (boolean $value)
Methods
copyFrom (line 205)

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.

  • access: public
void copyFrom (TStyle $style)
  • TStyle $style: the new style

Redefinition of:
TPanelStyle::copyFrom()
Copies the fields in a new style to this style.
getButtonType (line 56)
  • return: the type of command button. Defaults to TDataGridPagerButtonType::LinkButton.
  • access: public
TDataGridPagerButtonType getButtonType ()
getFirstPageText (line 104)
  • return: text for the first page button. Defaults to '<<'.
  • access: public
string getFirstPageText ()
getLastPageText (line 120)
  • return: text for the last page button. Defaults to '>>'.
  • access: public
string getLastPageText ()
getMode (line 40)
  • return: pager mode. Defaults to TDataGridPagerMode::NextPrev.
  • access: public
TDataGridPagerMode getMode ()
getNextPageText (line 72)
  • return: text for the next page button. Defaults to '>'.
  • access: public
string getNextPageText ()
getPageButtonCount (line 136)
  • return: maximum number of pager buttons to be displayed. Defaults to 10.
  • access: public
integer getPageButtonCount ()
getPosition (line 155)
  • return: where the pager is to be displayed. Defaults to TDataGridPagerPosition::Bottom.
  • access: public
TDataGridPagerPosition getPosition ()
getPrevPageText (line 88)
  • return: text for the previous page button. Defaults to '<'.
  • access: public
string getPrevPageText ()
getVisible (line 171)
  • return: whether the pager is visible. Defaults to true.
  • access: public
boolean getVisible ()
mergeWith (line 233)

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.

  • access: public
void mergeWith (TStyle $style)
  • TStyle $style: the new style

Redefinition of:
TPanelStyle::mergeWith()
Merges the style with a new one.
reset (line 187)

Resets the style to the original empty state.

  • access: public
void reset ()

Redefinition of:
TPanelStyle::reset()
Sets the style attributes to default values.
setButtonType (line 64)
  • access: public
void setButtonType (TDataGridPagerButtonType $value)
setFirstPageText (line 112)
  • access: public
void setFirstPageText (string $value)
  • string $value: text for the first page button.
setLastPageText (line 128)
  • access: public
void setLastPageText (string $value)
  • string $value: text for the last page button.
setMode (line 48)
  • access: public
void setMode (TDataGridPagerMode $value)
setNextPageText (line 80)
  • access: public
void setNextPageText (string $value)
  • string $value: text for the next page button.
setPageButtonCount (line 145)
  • throws: TInvalidDataValueException if the value is less than 1.
  • access: public
void setPageButtonCount (integer $value)
  • integer $value: maximum number of pager buttons to be displayed
setPosition (line 163)
  • access: public
void setPosition (TDataGridPagerPosition $value)
setPrevPageText (line 96)
  • access: public
void setPrevPageText (string $value)
  • string $value: text for the previous page button.
setVisible (line 179)
  • access: public
void setVisible (boolean $value)
  • boolean $value: whether the pager is visible.

Inherited Methods

Inherited From TPanelStyle

TPanelStyle::addAttributesToRender()
TPanelStyle::copyFrom()
TPanelStyle::getBackImageUrl()
TPanelStyle::getDirection()
TPanelStyle::getHorizontalAlign()
TPanelStyle::getScrollBars()
TPanelStyle::getWrap()
TPanelStyle::mergeWith()
TPanelStyle::reset()
TPanelStyle::setBackImageUrl()
TPanelStyle::setDirection()
TPanelStyle::setHorizontalAlign()
TPanelStyle::setScrollBars()
TPanelStyle::setWrap()

Inherited From TStyle

TStyle::__construct()
TStyle::addAttributesToRender()
TStyle::clearStyleField()
TStyle::copyFrom()
TStyle::getBackColor()
TStyle::getBorderColor()
TStyle::getBorderStyle()
TStyle::getBorderWidth()
TStyle::getCssClass()
TStyle::getCustomStyle()
TStyle::getDisplayStyle()
TStyle::getFont()
TStyle::getForeColor()
TStyle::getHeight()
TStyle::getStyleField()
TStyle::getStyleFields()
TStyle::getWidth()
TStyle::hasCssClass()
TStyle::hasFont()
TStyle::hasStyleField()
TStyle::mergeWith()
TStyle::reset()
TStyle::setBackColor()
TStyle::setBorderColor()
TStyle::setBorderStyle()
TStyle::setBorderWidth()
TStyle::setCssClass()
TStyle::setCustomStyle()
TStyle::setDisplayStyle()
TStyle::setForeColor()
TStyle::setHeight()
TStyle::setStyleField()
TStyle::setWidth()
TStyle::__clone()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()

Documentation generated on Mon, 25 Jun 2012 14:37:49 +0200 by phpDocumentor 1.4.3