Class TTabView

Description

TTabView class.

TTabView represents a view in a TTabPanel control.

The content in a TTabView can be specified by the Text property or its child controls. In template syntax, the latter means enclosing the content within the TTabView component element. If both are set, Text takes precedence.

Each TTabView is associated with a tab in the tab bar of the TTabPanel control. The tab caption is specified by Caption. If NavigateUrl is set, the tab will contain a hyperlink pointing to the specified URL. In this case, clicking on the tab will redirect the browser to the specified URL.

TTabView may be toggled between visible (active) and invisible (inactive) by setting the Active property.

  • author: Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: TTabPanel.php 3161 2012-06-04 08:47:39Z ctrlaltca $
  • since: 3.1.1

Located in /Web/UI/WebControls/TTabPanel.php (line 547)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TTabView
Method Summary
boolean getActive ()
string getCaption ()
string getNavigateUrl ()
the getTagName ()
string getText ()
void renderContents (THtmlWriter $writer)
void renderTab (THtmlWriter $writer)
void renderTabContent (THtmlWriter $writer)
void setActive (boolean $value)
void setCaption (string $value)
void setNavigateUrl (string $value)
void setText (string $value)
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
addAttributesToRender (line 563)

Adds attributes to renderer.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)

Redefinition of:
TWebControl::addAttributesToRender()
Adds attribute name-value pairs to renderer.
getActive (line 630)
  • return: whether this tab view is active. Defaults to false.
  • access: public
boolean getActive ()
getCaption (line 578)
  • return: the caption displayed on this tab. Defaults to ''.
  • access: public
string getCaption ()
getNavigateUrl (line 594)
  • return: the URL of the target page. Defaults to ''.
  • access: public
string getNavigateUrl ()
getTagName (line 554)
  • return: tag name for the view element
  • access: protected
the getTagName ()

Redefinition of:
TWebControl::getTagName()
Returns the tag name used for this control.
getText (line 612)
  • return: the text content displayed on this view. Defaults to ''.
  • access: public
string getText ()
renderContents (line 647)

Renders body contents of the tab view.

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

Redefinition of:
TWebControl::renderContents()
Renders the body content enclosed between the control tag.
renderTab (line 659)

Renders the tab associated with the tab view.

  • access: public
void renderTab (THtmlWriter $writer)
  • THtmlWriter $writer: the writer for rendering purpose.
renderTabContent (line 681)

Renders the content in the tab.

By default, a hyperlink is displayed.

  • access: protected
void renderTabContent (THtmlWriter $writer)
setActive (line 638)
  • access: public
void setActive (boolean $value)
  • boolean $value: whether this tab view is active.
setCaption (line 586)
  • access: public
void setCaption (string $value)
  • string $value: the caption displayed on this tab
setNavigateUrl (line 604)

Sets the URL of the target page.

If not empty, clicking on this tab will redirect the browser to the specified URL.

  • access: public
void setNavigateUrl (string $value)
  • string $value: the URL of the target page.
setText (line 622)

Sets the text content to be displayed on this view.

If this is not empty, the child content of the view will be ignored.

  • access: public
void setText (string $value)
  • string $value: the text content displayed on this view

Inherited Methods

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getIsSkinApplied()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

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()
Class Constants

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