PRADO 3.0.6 : Vue détaillée de TPanel.php

TPanel class file

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TPanel.php 1397 2006-09-07 07:55:53Z wei $
Poids:	237 lignes (7 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 1 class

TPanel:: (19 méthodes):
  getTagName()
  createStyle()
  addAttributesToRender()
  getWrap()
  setWrap()
  getHorizontalAlign()
  setHorizontalAlign()
  getBackImageUrl()
  setBackImageUrl()
  getDirection()
  setDirection()
  getDefaultButton()
  setDefaultButton()
  getGroupingText()
  setGroupingText()
  getScrollBars()
  setScrollBars()
  renderBeginTag()
  renderEndTag()

Classe: TPanel - X-Ref

TPanel class

TPanel represents a component that acts as a container for other component.
It is especially useful when you want to generate components programmatically
or hide/show a group of components.

By default, TPanel displays a <div> element on a page.
Children of TPanel are displayed as the body content of the element.
The property {@link setWrap Wrap} can be used to set whether the body content
should wrap or not. {@link setHorizontalAlign HorizontalAlign} governs how
the content is aligned horizontally, and {@link getDirection Direction} indicates
the content direction (left to right or right to left). You can set
{@link setBackImageUrl BackImageUrl} to give a background image to the panel,
and you can ste {@link setGroupingText GroupingText} so that the panel is
displayed as a field set with a legend text. Finally, you can specify
a default button to be fired when users press 'return' key within the panel
by setting the {@link setDefaultButton DefaultButton} property.

getTagName() X-Ref

return: string tag name of the panel

createStyle() X-Ref

Creates a style object to be used by the control.
This method overrides the parent impementation by creating a TPanelStyle object.

return: TPanelStyle the style used by TPanel.

addAttributesToRender($writer) X-Ref

Adds attributes to renderer.

param: THtmlWriter the renderer

getWrap() X-Ref

return: boolean whether the content wraps within the panel. Defaults to true.

setWrap($value) X-Ref

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

param: boolean whether the content wraps within the panel.

getHorizontalAlign() X-Ref

return: string the horizontal alignment of the contents within the panel, defaults to 'NotSet'.

setHorizontalAlign($value) X-Ref

Sets the horizontal alignment of the contents within the panel.
Valid values include 'NotSet', 'Justify', 'Left', 'Right', 'Center'

param: string the horizontal alignment

getBackImageUrl() X-Ref

return: string the URL of the background image for the panel component.

setBackImageUrl($value) X-Ref

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

param: string the URL

getDirection() X-Ref

return: string alignment of the content in the panel. Defaults to 'NotSet'.

setDirection($value) X-Ref

param: string alignment of the content in the panel.

getDefaultButton() X-Ref

return: string the ID path to the default button. Defaults to empty.

setDefaultButton($value) X-Ref

Specifies the default button for the panel.
The default button will be fired (clicked) whenever a user enters 'return'
key within the panel.
The button must be locatable via the function call {@link TControl::findControl findControl}.

param: string the ID path to the default button.

getGroupingText() X-Ref

return: string the legend text when the panel is used as a fieldset. Defaults to empty.

setGroupingText($value) X-Ref

param: string the legend text. If this value is not empty, the panel will be rendered as a fieldset.

getScrollBars() X-Ref

return: string the visibility and position of scroll bars in a panel control, defaults to None.

setScrollBars($value) X-Ref

param: string the visibility and position of scroll bars in a panel control.

renderBeginTag($writer) X-Ref

Renders the openning tag for the control (including attributes)

param: THtmlWriter the writer used for the rendering purpose

renderEndTag($writer) X-Ref

Renders the closing tag for the control

param: THtmlWriter the writer used for the rendering purpose

Code source de PRADO 3.0.6

/framework/Web/UI/WebControls/ -> TPanel.php (sommaire)

Définit 1 class