Class TDataGridPagerStyle

Description

TDataGridPagerStyle class.

TDataGridPagerStyle specifies the styles available for a datagrid pager.

Located in /Web/UI/WebControls/TDataGrid.php (line 2062)

TComponent
   |
   --TStyle
      |
      --TPanelStyle
         |
         --TDataGridPagerStyle
Method Summary
void copyFrom (TStyle $style)
string getButtonType ()
string getMode ()
string getNextPageText ()
integer getPageButtonCount ()
string getPosition ()
string getPrevPageText ()
boolean getVisible ()
void mergeWith (TStyle $style)
void reset ()
void setButtonType (string $value)
void setMode (string $value)
void setNextPageText (string $value)
void setPageButtonCount (integer $value)
void setPosition (string $value)
void setPrevPageText (string $value)
void setVisible (boolean $value)
Methods
copyFrom (line 2208)

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 2091)
  • return: the type of command button. Defaults to LinkButton.
  • access: public
string getButtonType ()
getMode (line 2075)
  • return: pager mode. Defaults to 'NextPrev'.
  • access: public
string getMode ()
getNextPageText (line 2107)
  • return: text for the next page button. Defaults to '>'.
  • access: public
string getNextPageText ()
getPageButtonCount (line 2139)
  • return: maximum number of pager buttons to be displayed. Defaults to 10.
  • access: public
integer getPageButtonCount ()
getPosition (line 2158)
  • return: where the pager is to be displayed. Defaults to 'Bottom'.
  • access: public
string getPosition ()
getPrevPageText (line 2123)
  • return: text for the previous page button. Defaults to '<'.
  • access: public
string getPrevPageText ()
getVisible (line 2174)
  • return: whether the pager is visible. Defaults to true.
  • access: public
boolean getVisible ()
mergeWith (line 2236)

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 2190)

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 2099)
  • access: public
void setButtonType (string $value)
  • string $value: the type of command button, LinkButton or PushButton
setMode (line 2083)
  • access: public
void setMode (string $value)
  • string $value: pager mode. Valid values include 'NextPrev' and 'Numeric'.
setNextPageText (line 2115)
  • access: public
void setNextPageText (string $value)
  • string $value: text for the next page button.
setPageButtonCount (line 2148)
  • access: public
  • throws: TInvalidDataValueException if the value is less than 1.
void setPageButtonCount (integer $value)
  • integer $value: maximum number of pager buttons to be displayed
setPosition (line 2166)
  • access: public
void setPosition (string $value)
  • string $value: where the pager is to be displayed. Valid values include 'Bottom', 'Top', 'TopAndBottom'
setPrevPageText (line 2131)
  • access: public
void setPrevPageText (string $value)
  • string $value: text for the next page button.
setVisible (line 2182)
  • 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::getFont()
TStyle::getForeColor()
TStyle::getHeight()
TStyle::getStyleField()
TStyle::getWidth()
TStyle::hasStyleField()
TStyle::mergeWith()
TStyle::reset()
TStyle::setBackColor()
TStyle::setBorderColor()
TStyle::setBorderStyle()
TStyle::setBorderWidth()
TStyle::setCssClass()
TStyle::setCustomStyle()
TStyle::setForeColor()
TStyle::setHeight()
TStyle::setStyleField()
TStyle::setWidth()

Inherited From TComponent

TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()

Documentation generated on Sun, 04 Jun 2006 18:59:07 -0400 by phpDocumentor 1.3.0RC4