Class TPanelStyle

Description

TPanelStyle class.

TPanelStyle represents the CSS style specific for panel HTML tag.

Located in /Web/UI/WebControls/TPanel.php (line 240)

TComponent
   |
   --TStyle
      |
      --TPanelStyle
Direct descendents
Class Description
TDataGridPagerStyle TDataGridPagerStyle class.
Method Summary
void copyFrom (TStyle $style)
string getBackImageUrl ()
string getDirection ()
string getHorizontalAlign ()
string getScrollBars ()
boolean getWrap ()
void mergeWith (TStyle $style)
void reset ()
void setBackImageUrl (string $value)
void setDirection (string $value)
void setHorizontalAlign (string $value)
void setScrollBars (string $value)
void setWrap (boolean $value)
Methods
addAttributesToRender (line 268)

Adds attributes related to CSS styles to renderer.

This method overrides the parent implementation.

  • access: public
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TStyle::addAttributesToRender()
Adds attributes related to CSS styles to renderer.
copyFrom (line 405)

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:
TStyle::copyFrom()
Copies the fields in a new style to this style.

Redefined in descendants as:
getBackImageUrl (line 301)
  • return: the URL of the background image for the panel component.
  • access: public
string getBackImageUrl ()
getDirection (line 318)
  • return: alignment of the content in the panel. Defaults to 'NotSet'.
  • access: public
string getDirection ()
getHorizontalAlign (line 352)
  • return: the horizontal alignment of the contents within the panel, defaults to 'NotSet'.
  • access: public
string getHorizontalAlign ()
getScrollBars (line 370)
  • return: the visibility and position of scroll bars in a panel control, defaults to None.
  • access: public
string getScrollBars ()
getWrap (line 335)
  • return: whether the content wraps within the panel. Defaults to true.
  • access: public
boolean getWrap ()
mergeWith (line 429)

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:
TStyle::mergeWith()
Merges the style with a new one.

Redefined in descendants as:
reset (line 389)

Sets the style attributes to default values.

This method overrides the parent implementation by resetting additional TTableStyle specific attributes.

  • access: public
void reset ()

Redefinition of:
TStyle::reset()
Resets the style to the original empty state.

Redefined in descendants as:
setBackImageUrl (line 310)

Sets the URL of the background image for the panel component.

  • access: public
void setBackImageUrl (string $value)
  • string $value: the URL
setDirection (line 327)
  • access: public
void setDirection (string $value)
  • string $value: alignment of the content in the panel. Valid values include 'NotSet', 'LeftToRight', 'RightToLeft'.
setHorizontalAlign (line 362)

Sets the horizontal alignment of the contents within the panel.

Valid values include 'NotSet', 'Justify', 'Left', 'Right', 'Center'

  • access: public
void setHorizontalAlign (string $value)
  • string $value: the horizontal alignment
setScrollBars (line 379)
  • access: public
void setScrollBars (string $value)
  • string $value: the visibility and position of scroll bars in a panel control. Valid values include None, Auto, Both, Horizontal and Vertical.
setWrap (line 344)

Sets the value indicating whether the content wraps within the panel.

  • access: public
void setWrap (boolean $value)
  • boolean $value: whether the content wraps within the panel.

Inherited Methods

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 19:00:03 -0400 by phpDocumentor 1.3.0RC4