phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
PntTablePart Class Reference

Inherits PntPagePart.

Inherited by PntHorizontalTablePart, and TablePart.

Public Member Functions

 __construct ($whole, $requestData, $itemType=null, $propPaths=null)
 
 getName ()
 
 addHeaderSortParams ($index, $params)
 
 setItems ($items)
 
 setSelectedId ($value)
 
 setItemSelectWidgets ($value)
 
 setNoTableIfNoItems ($value)
 
 setShowPropHeaders ($value)
 
 setTableWidth ($value)
 
 setBgColor ($value)
 
 setItemBgColor ($value)
 
 setItemHlColor ($value)
 
 setHandler_printTableHeaders ($handler)
 
 setHandler_printRows ($handler)
 
 setHandler_printItemSelectCell ($handler)
 
 setHandler_printItemCells ($handler)
 
 setHandler_printItemCellContent ($handler)
 
 setHandler_getCellOnClickParam ($handler)
 
 setHandler_printTableFooter ($handler)
 
 setHandler_printItemBgColor ($handler)
 
 initialize ($itemType, $propPaths)
 
 addPropPaths ($arrayOrString)
 
 addPropPath ($path, $label)
 
 getItemType ()
 
 getItems ()
 
 printAnchorFor ($item)
 
 printCheckboxCheckedFor ($item)
 
 printTableId ()
 
 getTableId ()
 
 getAppName ()
 
 printBody ()
 
 printExtraTableAtts ()
 
 printThead ()
 
 printNoItemMessage ()
 
 printItemSelectHeader ()
 
 printTableHeaders ($table)
 
 printRows ($table)
 
 printRow ($table, $item, $key)
 
 printItemBgColor ($table, $item, $key=null)
 
 printItemSelectCell ($item, $key=null)
 
 printItemCells ($table, $item, $rowKey=null)
 
 printItemCellContent ($table, $item, $cell)
 
 getCellOnClickParam ($table, $item)
 
 printTableFooter ($table)
 
 setShowTableHeaders ($value)
 
 setRowBgColor ($value)
 
 setRowHlColor ($value)
 
 addColumnPaths ($arrayOrString)
 
 addColumnPath ($path, $label)
 
 setHandler_printItemRows ($handler)
 
 printItemRows ($table)
 
 setHandler_printRowBgColor ($handler)
 
- 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

 $noItemsMessage = 'No Items'
 
 $noTableIfNoItems = true
 
 $itemSelectWidgets = true
 
 $tableWidth =''
 
 $selectedId =-1
 
 $showPropHeaders = true
 
 $itemBgColor ='white'
 
 $itemHlColor ='#ffffa0'
 
 $bgColor
 
 $extraTableAtts = "onkeypress=\"window.location.href='#'+String.fromCharCode(event.keyCode).toLowerCase();\""
 
 $showTableHeaders
 
 $rowBgColor
 
 $rowHlColor
 
 $handler_printItemRows
 
 $pntTableEqField
 

Additional Inherited Members

- Static Public Member Functions inherited from PntPage
static getInfoStyleOk ()
 
static getInfoStyleError ()
 
static getInfoStyleWarning ()
 

Constructor & Destructor Documentation

__construct (   $whole,
  $requestData,
  $itemType = null,
  $propPaths = null 
)
Parameters
string$itemTypemust be safe to print without encoding

Member Function Documentation

addColumnPath (   $path,
  $label 
)
addColumnPaths (   $arrayOrString)
addHeaderSortParams (   $index,
  $params 
)

Adds html DOM parameters to be added to the table headers.

Parameters
int$index
string$paramsHTML
addPropPath (   $path,
  $label 
)
addPropPaths (   $arrayOrString)
getAppName ( )
getCellOnClickParam (   $table,
  $item 
)

Return the onClick parameter for inmclusion in the TD tags by printItemCells Eventhandler PntTablePart $table $this, made explicit for copy&paste as event handler PntObject $item the item this row displays mixed $cellKey (optional) key of the cell content provider in $table->cells

getItems ( )
getItemType ( )
getName ( )
getTableId ( )
Returns
string (untrusted) value of the id parameter of the table tag
initialize (   $itemType,
  $propPaths 
)
printAnchorFor (   $item)
printBody ( )
printCheckboxCheckedFor (   $item)
printExtraTableAtts ( )
printItemBgColor (   $table,
  $item,
  $key = null 
)
printItemCellContent (   $table,
  $item,
  $cell 
)
printItemCells (   $table,
  $item,
  $rowKey = null 
)

Prints TD's for the supplied item, after an eventual ItemSelectCell has been printed Eventhandler PntTablePart $table $this, made explicit for copy&paste as event handler PntObject $item the item this row displays

printItemRows (   $table)
printItemSelectCell (   $item,
  $key = null 
)
printItemSelectHeader ( )
printNoItemMessage ( )
printRow (   $table,
  $item,
  $key 
)
printRows (   $table)
printTableFooter (   $table)

Prints eventual footer Eventhandler. Default implementation is do nothing PntTablePart $table $this, made explicit for copy&paste as event handler

printTableHeaders (   $table)

Prints TD's for the header row, after an eventual ItemSelectHeader has been printed Eventhandler PntTablePart $table === $this, made explicit for copy&paste as event handler

printTableId ( )
printThead ( )
setBgColor (   $value)
Parameters
HTML$value
setHandler_getCellOnClickParam (   $handler)
setHandler_printItemBgColor (   $handler)
setHandler_printItemCellContent (   $handler)
setHandler_printItemCells (   $handler)
setHandler_printItemRows (   $handler)
setHandler_printItemSelectCell (   $handler)
setHandler_printRowBgColor (   $handler)
setHandler_printRows (   $handler)
setHandler_printTableFooter (   $handler)
setHandler_printTableHeaders (   $handler)
setItemBgColor (   $value)
Parameters
HTML$value
setItemHlColor (   $value)
Parameters
HTML$value
setItems (   $items)
setItemSelectWidgets (   $value)
setNoTableIfNoItems (   $value)
setRowBgColor (   $value)
setRowHlColor (   $value)
setSelectedId (   $value)
setShowPropHeaders (   $value)
setShowTableHeaders (   $value)
setTableWidth (   $value)
Parameters
string$value

Field Documentation

$bgColor

HTML table backgroundcolor

$extraTableAtts = "onkeypress=\"window.location.href='#'+String.fromCharCode(event.keyCode).toLowerCase();\""

Extra attributes for table tag

$handler_printItemRows
$itemBgColor ='white'

HTML item backgroundcolor

$itemHlColor ='#ffffa0'

HTML item highlightcolor

$itemSelectWidgets = true

If true checkboxes are printed at the start of each row

$noItemsMessage = 'No Items'

HTML message shown instead of rows if noTableIfNoItems

$noTableIfNoItems = true

If true no table is shown if no items

$pntTableEqField
$rowBgColor
$rowHlColor
$selectedId =-1
$showPropHeaders = true

If true a header row with columnlabels is printed

$showTableHeaders
$tableWidth =''

int or empy string


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