Overview

Packages

  • Actions
  • Codegen
  • Controls
    • Base
  • DatabaseAdapters
  • Events
  • None
  • Sessions
  • Tests

Classes

  • QAccordionBase
  • QAccordionGen
  • QAutocompleteBase
  • QAutocompleteGen
  • QDatepickerBase
  • QDatepickerBoxBase
  • QDatepickerBoxGen
  • QDatepickerGen
  • QDialogBase
  • QDialogGen
  • QDraggableBase
  • QDraggableGen
  • QDroppableBase
  • QDroppableGen
  • QFieldset
  • QJqButtonBase
  • QJqButtonGen
  • QJqCheckBoxBase
  • QJqCheckBoxGen
  • QJqRadioButtonBase
  • QJqRadioButtonGen
  • QMenuBase
  • QMenuGen
  • QProgressbarBase
  • QProgressbarGen
  • QResizableBase
  • QResizableGen
  • QSelectableBase
  • QSelectableGen
  • QSelectMenu
  • QSelectMenuBase
  • QSelectMenuGen
  • QSliderBase
  • QSliderGen
  • QSortableBase
  • QSortableGen
  • QSpinnerBase
  • QSpinnerGen
  • QTabsBase
  • QTabsGen
  • QTextBoxBase
  • Overview
  • Package
  • Class

Class QTabsBase

Implements JQuery Ui Tabs

Tabs are similar to an Accordion, but tabs along the top are used to switch between panels. The top level html items in the panel will become the items that are switched.

Specify the names of the tabs either in the TabHeadersArray, or assign a Name attribute to the top level child controls and those names will be used as the tab names.

QBaseClass
Extended by QHtmlAttributeManagerBase
Extended by QHtmlAttributeManager
Extended by QControlBase
Extended by QControl
Extended by QBlockControl
Extended by QPanel
Extended by QTabsGen
Extended by QTabsBase

Direct known subclasses

QTabs
Package: Controls\Base
Link: http://jqueryui.com/tabs/
Located at includes/base_controls/QTabsBase.class.php
Methods summary
public string
# GetEndScript( )

Return the javascript associated with the control.

Return the javascript associated with the control.

Returns

string

Overrides

QTabsGen::GetEndScript()
protected null|string
# RenderChildren( boolean $blnDisplayOutput = true )

Renders child controls as divs so that they become tabs.

Renders child controls as divs so that they become tabs.

Parameters

$blnDisplayOutput

Returns

null|string

Overrides

QControlBase::RenderChildren()
protected string
# GetTabHeaderHtml( )

Returns the HTML for the tab header. This includes the names and the control logic to record what the user clicked.

Returns the HTML for the tab header. This includes the names and the control logic to record what the user clicked.

Returns

string
public
# SetHeader( integer|QControl|string $mixHeaderIndicator, string|QControl $mixHeader )

Set the tab header for a tab

Set the tab header for a tab

Give it a control and a name to set the header

TBD: impelment ajax fetch of tab content

Parameters

$mixHeaderIndicator
either the 0-based index of the header, or the section control or that control's id
$mixHeader
string or control to render as the tab header
public
# Refresh( )

Generated method overrides the built-in QControl method, causing it to not redraw completely. We restore its functionality here.

Generated method overrides the built-in QControl method, causing it to not redraw completely. We restore its functionality here.

Overrides

QTabsGen::Refresh()
public boolean
# ValidateControlAndChildren( )

Overrides default so that if a tab does not pass validation, it will be visible.

Overrides default so that if a tab does not pass validation, it will be visible.

Returns

boolean

Overrides

QControlBase::ValidateControlAndChildren()
protected boolean|integer
# FindTabIndex( string|integer $mixTab )

Given a tab name, index or control ID, returns its index. If invalid, returns false;

Given a tab name, index or control ID, returns its index. If invalid, returns false;

Parameters

$mixTab

Returns

boolean|integer
public
# ActivateTab( string|integer $mixTab )

Activate the tab with the given name, number or controlId.

Activate the tab with the given name, number or controlId.

Parameters

$mixTab
The tab name, tab index number or control ID
public
# EnableTab( null|string|integer $mixTab = null, boolean $blnEnable = true )

Enable or disable a tab, or all tabs.

Enable or disable a tab, or all tabs.

Parameters

$mixTab
If null, enables or disables all tabs. Otherwise, the name or index of a tab.
$blnEnable
True to enable tabs. False to disable.
public
# AddChildControl( QControl $objControl )

Overriding to keep info in sync.

Overriding to keep info in sync.

Parameters

$objControl

Overrides

QControlBase::AddChildControl()
protected mixed
# GetState( )

Returns the state data to restore later.

Returns the state data to restore later.

Returns

mixed

Overrides

QControlBase::GetState()
protected
# PutState( mixed $state )

Restore the state of the control.

Restore the state of the control.

Parameters

$state

Overrides

QControlBase::PutState()
public mixed
# __get( string $strName )

PHP __get magic method implementation

PHP __get magic method implementation

Parameters

$strName
Name of the property

Returns

mixed

Throws

Exception|QCallerException

Overrides

QTabsGen::__get()
public mixed
# __set( string $strName, string $mixValue )

PHP __set magic method implementation

PHP __set magic method implementation

Parameters

$strName
Property Name
$mixValue
Property Value

Returns

mixed

Throws

Exception|QCallerException|QInvalidCastException

Overrides

QTabsGen::__set()
Methods inherited from QTabsGen
Destroy(), Disable(), Disable1(), Disable2(), Enable(), Enable1(), Enable2(), GetJqSetupFunction(), GetModelConnectorParams(), Instance(), Load(), Load1(), MakeJqOptions(), Option(), Option1(), Option2(), Option3()
Methods inherited from QBlockControl
AddControlToMove(), AddDropZone(), GetControlHtml(), GetInnerHtml(), ParsePostData(), RemoveAllControlsToMove(), RemoveAllDropZones(), RemoveControlToMove(), RemoveDropZone(), Validate()
Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState(), __construct()
Methods inherited from QHtmlAttributeManagerBase
AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()
Methods inherited from QBaseClass
OverrideAttributes(), __call()
Constants inherited from QControlBase
CommentEnd, CommentStart
Properties summary
protected array $objTabHeadersArray

Names of tabs. Can also specify with Name attribute of child controls.

Names of tabs. Can also specify with Name attribute of child controls.

# array()
protected boolean $blnAutoRenderChildren

Automatically render the children by default, since these are the tabs.

Automatically render the children by default, since these are the tabs.

# true
protected string $strSelectedId

ControlId of currently selected child item. Use ->Active to get the index of the current selection.

ControlId of currently selected child item. Use ->Active to get the index of the current selection.

# null
Properties inherited from QTabsGen
$blnCollapsible, $mixActive, $mixDisabled, $mixHide, $mixShow, $strEvent, $strHeightStyle, $strJavaScripts, $strStyleSheets
Properties inherited from QPanel
$blnHtmlEntities, $blnIsBlockElement, $strDefaultDisplayStyle, $strTagName
Properties inherited from QBlockControl
$blnDropTarget, $objDropsControlsArray, $objDropsGroupingsArray, $objIsDropZoneFor, $objMovesControlsArray, $strFormat, $strTemplate, $strText
Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strName, $strPreferredRenderMethod, $strRenderMethod, $strValidationError, $strWarning
Properties inherited from QHtmlAttributeManagerBase
$attributes, $styles
Magic properties summary
public read-only array $SelectedId

Control Id of the selected pane. Use ->Active to get the zero-based index of the selected pane.

public write-only array $Headers

Array of names for the tabs. You can also specify by assigning the Name attribute of each pane.

Magic properties inherited from QTabsGen
$Active, $Collapsible, $Disabled, $Event, $HeightStyle, $Hide, $Show
Magic properties inherited from QBlockControl
$AutoRenderChildren, $DropTarget, $Format, $HorizontalAlign, $HtmlEntities, $ResizeHandleDirection, $ResizeHandleMaximum, $ResizeHandleMinimum, $TagName, $Template, $Text, $VerticalAlign
Magic properties inherited from QControlBase
$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified
Magic properties inherited from QHtmlAttributeManagerBase
$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $Width
API documentation generated by ApiGen