PntTabsPart Class Reference

Inherits PntPagePart.

Inherited by TabsPart.

Public Member Functions
	__construct ($whole, $requestData, $tabsSpec, $selected=null)
	initialize ($tabsSpec, $selected=null)
	setTabsSpec ($tabsSpec)
	processPartArgumentsConvertTabsSpec ()
	setSelected ($value)
	setName ($value)
	setJsSelectFunc ($value)
	setHandler_printTabDiv ($eventHandler)
	setHandler_printContentDivTag ($eventHandler)
	setHandler_printContentPart ($eventHandler)
	getSelectedKey ()
	getName ()
	printBody ()
	printScript ()
	getJsTabsArrayName ()
	printTabBar ()
	printTabDiv ($tabsPart, $key, $label)
	printContent ()
	printContentDivPart ($name, $label)
	printContentDivTag ($tabsPart, $name)
	printContentPart ($tabsPart, $name, $label)
	getContentPart ($name)
Public Member Functions inherited from PntPagePart
	printBody ()
	ajaxPrintUpdates ($preFix='')
	getThisPntHandlerName ()
	getType ()
	getRequestedObject ()
	getFormTexts ()
	getOwnFormTexts ()
	getFootprintId ()
	getExcludedMultiValuePropButtonKeys ()
Public Member Functions inherited from PntPage
	getInfoStyle ()
	setInfoStyle ($value)
	printHeader ()
	printFooter ()
	printBodyTagIeExtraPiece ()
	includeSkin ($name, $param=null)
	printSetTitle ($title=null)
	getButton ($caption, $script, $ghost=false, $len=null)
	handleRequest ()
	getPartId ()
	ajaxHandleRequest ()
	ajaxPrintHeaders ()
	ajaxPrintUpdates ($preFix='')
	getAjaxUpdatePartIds ()
	getAjaxUpdateSubPartIds ($prefix)
	ajaxShouldUpdate ($partId, $partName=null, $extraParam=null)
	ajaxPrintPartUpdate ($partName, $partId=null, $extraParam=null)
	isRequestAjax ()
	ajaxPrintPartAttributes ()
	getAjaxLoadingMessage ()
	initForHandleRequest ()
	checkAccess ()
	isLayoutReport ()
	printHeaders ()
	printHeaderXframeOptions ()
	getCharset ()
	printBody ()
	printMainPart ()
	printPart ($partName)
	imp_printPart ($args)
	getPart ($args, $cache=true)
	getPartIncludeTryParams ($partName)
	getSpecificPartPrefix ($partName=null)
	printPartDebugComment ($partName, $debug)
	printInformationPart ()
	getFilterPartString ()
	getButtonsList ()
	addMultiValuePropertyButtons (&$buttons)
	getExcludedMultiValuePropButtonKeys ()
	getMultiValuePropertyButtonScript ($propName, $edit=false)
	getThisPntContext ()
	getDetailsHref ($appName, $pntType)
	getLinkDirFromNav ($nav, $pntHandler='')
	getTargetAppName ($nav, $pntHandler='')
	getDetailsLinkPntHandler ()
	getNoItemsMessage ()
	getRequestDuration ()
	getConvert ($obj, $path, $kind=0, $preformatAndTab=0)
	getInitConverter ($prop)
	addContextButtonTo (&$buttons)
	doScouting ()
	getFootprintId ()
	printFootprintJsLiteral ($quote="'")
	getPropertyName ()
	printNextActionTicket ()
	getAndCreateNextActionTicket ()
	printExtraHeaders ()
	getImagesDir ()
Public Member Functions inherited from PntRequestHandler
	__construct ($whole, $requestData)
	getDir ()
	getDomainDir ($type=null)
	getBaseUrl ()
	getConverter ()
	getDebugMode ()
	initForHandleRequest ()
	startSession ()
	getContextHref ($footprintId)
	getController ()
	getScout ()
	getGlobalFilters ()
	forwardRequest ($requestData, $information=null)
	redirectRequest ($requestData, $information=null, $dir=null)
	queryStringFrom ($requestData, $param=null)
	getRequestParam ($key)
	getReqParam ($key, $asHtml=false)
	htOut ($aString)
	getRequestHandler ($requestData, $dir=null)
	tryUseHandlerClass ($handlerClass, &$attempted)
	getHandlersTriedString ($attempted)
	__toString ()
	toString ()
	getLabel ()
	getName ()
	getThisPntHandlerName ()
	getInformation ()
	getEventualItemNotFoundMessage ()
	setInformation ($value)
	getTypeLabel ()
	getType ()
	checkAlphaNumeric ($value)
	getTryUseClassTryParams ($className, $dir)
	getIncludesDir ()
	tryUseClass ($className, $dir)
	useClass ($className, $dir)
	getTypeClassDescriptor ()
	getRequestedObject ()
	setRequestedObject ($value)
	getFormTexts ()
	getFormTextPaths ()
	setFormTexts ($value)
	getMarkedItemsCollector ()

Data Fields
	$tabsSpec
	$printDivs = true
	$tabsBarOnly = false
	$selected
	$jsSelectFunc = 'pntTabSelected'
	$contentParts

Additional Inherited Members
Static Public Member Functions inherited from PntPage
static	getInfoStyleOk ()
static	getInfoStyleError ()
static	getInfoStyleWarning ()

Constructor & Destructor Documentation

__construct	(		$whole,
			$requestData,
			$tabsSpec,
			$selected = null
	)

Constructor. $tabsSpec and $selected can be specified through print/getPart parameters on the whole

Member Function Documentation

getContentPart

(

$name

)

if a contentPart is specified for the tab, return it.

Parameters

String

$name

The name of the tab as appears in the tabsSpec

Returns

PntPagePart the part that will print the content for the tab

getJsTabsArrayName

(

)

getName

(

)

getSelectedKey

(

)

initialize	(		$tabsSpec,
			$selected = null
	)

call this method if multiple tabparts are used

printBody

(

)

prints the entire part

printContent

(

)

prints all content parts

printContentDivPart	(		$name,
			$label
	)

prints the specified content part and, if $this->printDiv, prints the div tags too

Parameters

string	$name	must be alphanumeric
HTML	$label

printContentDivTag	(		$tabsPart,
			$name
	)

eventhandler method, can be copied to other class Prints the div tag of the contentPart with the specified name. the id of the div tag must be the name of this concatenated with the name of the tab, concatenated with 'Content'.

Parameters

PntTabsPart	$tabsPart	$this
string	$name	the name of the part, as appears in the tabsSpec, mus be alphanumeric

printContentPart	(		$tabsPart,
			$name,
			$label
	)

eventhandler method, can be copied to other class Prints the contentPart with the specified name. Default implementation tries to delegate to specific part, if none, calls printPart on the whole with the name concatenated with 'Part'

Parameters

PntTabsPart	$tabsPart	$this
string	$name	the name of the part, as appears in the tabsSpec, must be alphanumeric
HTML	$label	label of the tab as it appears on the tab div

printScript

(

)

printTabBar

(

)

printTabDiv	(		$tabsPart,
			$key,
			$label
	)

eventhandler method, can be copied to other class

Parameters

string	$key	must be alphanumeric
HTML	$label

processPartArgumentsConvertTabsSpec

(

)

setHandler_printContentDivTag

(

$eventHandler

)

setHandler_printContentPart

(

$eventHandler

)

setHandler_printTabDiv

(

$eventHandler

)

setJsSelectFunc

(

$value

)

See Also

jsSelectFunc

setName

(

$value

)

The name is used to identify the tabPart's divs in javascript, if multiple tabparts are used on the same page, the name must be set

Parameters

string

$value

alphanumeric string that can be used as a javascript variable name

setSelected

(

$value

)

Sets the name of the tab that is initially selected as it appears in $tabSpec,

setTabsSpec

(

$tabsSpec

)

Sets the Array with tab names (must be alphanumeric). If a key is a string, it will be used als the tab label (must be HTML) If the value is an array, it should start with the tab name at index 0, followed by the getPart parameters. The array will be replaced by the tab name

Field Documentation

$contentParts

parts by tab name that generate content

$jsSelectFunc = 'pntTabSelected'

name of the javascript func tion called when the a tab is selected. set this variable to name your own func tion and call pntTabSelected from there if you need to do something more on tab selection then hiding/showing tabs your func tion must take two parameters, the first an array with all tab keys the second the key of the selected tab, and pass them on to pntTabSelected

See Also

scripts/general.js

$printDivs = true

if set to false the contentparts should print their own divs with names according to the tabsSepc concatenated with 'Div'

$selected

name of selected tab as it appears in $tabSpec, can be set from print/getPart parameters

$tabsBarOnly = false

If set to true only the tabsbar is printen, no content parts

$tabsSpec

Array with tab names. If a key is a string, it will be used as the tab label

---

The documentation for this class was generated from the following file:

• upload/classes/pnt/web/parts/classPntTabsPart.php