TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
ExtDirectNode Class Reference
Inheritance diagram for ExtDirectNode:
TreeNode ComparableNodeInterface PagetreeNode

Public Member Functions

 setType ($type)
 
 getType ()
 
 setLeaf ($isLeaf)
 
 isLeafNode ()
 
 setExpandable ($expandable)
 
 isExpandable ()
 
 setExpanded ($expanded)
 
 isExpanded ()
 
 setDraggable ($draggable)
 
 isDraggable ()
 
 setIsDropTarget ($isDropTarget)
 
 isDropTarget ()
 
 setText ($text, $textSourceField= 'title', $prefix= '', $suffix= '')
 
 getText ()
 
 setEditableText ($editableText)
 
 getEditableText ()
 
 getTextSourceField ()
 
 setInCopyMode ($inCopyMode)
 
 isInCopyMode ()
 
 setInCutMode ($inCutMode)
 
 isInCutMode ()
 
 getPrefix ()
 
 getSuffix ()
 
 setCls ($class)
 
 getCls ()
 
 setQTip ($qtip)
 
 getQTip ()
 
 setSpriteIconCode ($spriteIcon)
 
 getSpriteIconCode ()
 
 setLabelIsEditable ($labelIsEditable)
 
 isLabelEditable ()
 
 setRecord ($record)
 
 getRecord ()
 
 setContextInfo ($contextInfo)
 
 getContextInfo ()
 
 setChildNodes (\TYPO3\CMS\Backend\Tree\TreeNodeCollection $childNodes)
 
 setAllowChildren ($allowChildren)
 
 canHaveChildren ()
 
 toArray ($addChildNodes=true)
 
 dataFromArray ($data)
 
- Public Member Functions inherited from TreeNode
 __construct (array $data=array())
 
 setChildNodes (\TYPO3\CMS\Backend\Tree\TreeNodeCollection $childNodes)
 
 removeChildNodes ()
 
 getChildNodes ()
 
 hasChildNodes ()
 
 setId ($id)
 
 getId ()
 
 setParentNode (\TYPO3\CMS\Backend\Tree\TreeNode $parentNode=null)
 
 getParentNode ()
 
 equals (\TYPO3\CMS\Backend\Tree\TreeNode $other)
 
 compareTo ($other)
 
 toArray ($addChildNodes=true)
 
 dataFromArray ($data)
 
 serialize ()
 
 unserialize ($serializedString)
 

Protected Attributes

 $type = ''
 
 $leaf = true
 
 $expanded = false
 
 $expandable = false
 
 $draggable = true
 
 $isDropTarget = true
 
 $text = ''
 
 $editableText = ''
 
 $prefix = ''
 
 $suffix = ''
 
 $cls = ''
 
 $qtip = ''
 
 $spriteIconCode = ''
 
 $t3TextSourceField = ''
 
 $t3InCopyMode = false
 
 $t3InCutMode = false
 
 $record = array()
 
 $contextInfo = array()
 
 $labelIsEditable = true
 
 $allowChildren = true
 
- Protected Attributes inherited from TreeNode
 $id = ''
 
 $parentNode = null
 
 $childNodes = null
 

Detailed Description

Node for the usage with ExtDirect and ExtJS

Definition at line 20 of file ExtDirectNode.php.

Member Function Documentation

canHaveChildren ( )

Checks if the node can have child nodes

Returns
bool

Definition at line 567 of file ExtDirectNode.php.

References ExtDirectNode\$allowChildren.

Referenced by ExtDirectNode\toArray().

dataFromArray (   $data)
getCls ( )

Returns the css class(es)

Returns
string

Definition at line 427 of file ExtDirectNode.php.

References ExtDirectNode\$cls.

Referenced by ExtDirectNode\toArray().

getContextInfo ( )

Returns the context info

Returns
array

Definition at line 532 of file ExtDirectNode.php.

References ExtDirectNode\$contextInfo.

Referenced by ExtDirectNode\toArray().

getEditableText ( )

Returns the editable text

Returns
string

Definition at line 334 of file ExtDirectNode.php.

References ExtDirectNode\$editableText.

Referenced by ExtDirectNode\toArray().

getPrefix ( )

Returns the prefix text of the label

Returns
string

Definition at line 396 of file ExtDirectNode.php.

References ExtDirectNode\$prefix.

Referenced by ExtDirectNode\toArray().

getQTip ( )

Returns the quick tip

Returns
string

Definition at line 448 of file ExtDirectNode.php.

References ExtDirectNode\$qtip.

Referenced by ExtDirectNode\toArray().

getRecord ( )

Returns the database record array

Returns
array

Definition at line 511 of file ExtDirectNode.php.

References ExtDirectNode\$record.

getSpriteIconCode ( )

Returns the sprite icon code

Returns
string

Definition at line 469 of file ExtDirectNode.php.

References ExtDirectNode\$spriteIconCode.

Referenced by ExtDirectNode\toArray().

getSuffix ( )

Returns the suffix text of the label

Returns
string

Definition at line 406 of file ExtDirectNode.php.

References ExtDirectNode\$suffix.

Referenced by ExtDirectNode\toArray().

getText ( )

Returns the label

Returns
string

Definition at line 313 of file ExtDirectNode.php.

References ExtDirectNode\$text.

Referenced by ExtDirectNode\toArray().

getTextSourceField ( )

Returns the source field of the label

Returns
string

Definition at line 344 of file ExtDirectNode.php.

References ExtDirectNode\$t3TextSourceField.

Referenced by ExtDirectNode\toArray().

getType ( )

Returns the node type

Returns
string

Definition at line 178 of file ExtDirectNode.php.

References ExtDirectNode\$type.

Referenced by ExtDirectNode\toArray().

isDraggable ( )

Returns the draggable indicator

Returns
bool

Definition at line 265 of file ExtDirectNode.php.

References ExtDirectNode\$draggable.

Referenced by ExtDirectNode\toArray().

isDropTarget ( )

Returns the indicator if the node is a drop target

Returns
bool

Definition at line 286 of file ExtDirectNode.php.

References ExtDirectNode\$isDropTarget.

Referenced by ExtDirectNode\setIsDropTarget(), and ExtDirectNode\toArray().

isExpandable ( )

Returns the expandable indicator

Returns
bool

Definition at line 220 of file ExtDirectNode.php.

References ExtDirectNode\$expandable.

Referenced by ExtDirectNode\toArray().

isExpanded ( )

Returns the expanded indicator

Returns
bool

Definition at line 241 of file ExtDirectNode.php.

References ExtDirectNode\$expanded, and ExtDirectNode\isLeafNode().

Referenced by ExtDirectNode\toArray().

isInCopyMode ( )

Returns the copy mode indicator

Returns
bool

Definition at line 365 of file ExtDirectNode.php.

References ExtDirectNode\$t3InCopyMode.

Referenced by ExtDirectNode\toArray().

isInCutMode ( )

Returns the cut mode indicator

Returns
bool

Definition at line 386 of file ExtDirectNode.php.

References ExtDirectNode\$t3InCutMode.

Referenced by ExtDirectNode\toArray().

isLabelEditable ( )

Returns the editable label indicator

Returns
bool

Definition at line 490 of file ExtDirectNode.php.

References ExtDirectNode\$labelIsEditable.

Referenced by ExtDirectNode\toArray().

isLeafNode ( )

Returns if the node is a leaf node

Returns
bool

Definition at line 199 of file ExtDirectNode.php.

References ExtDirectNode\$leaf.

Referenced by PagetreeNode\canRemove(), ExtDirectNode\isExpanded(), and ExtDirectNode\toArray().

setAllowChildren (   $allowChildren)

Sets the indicator if the node can have child nodes

Parameters
bool$allowChildren
Returns
void

Definition at line 557 of file ExtDirectNode.php.

References ExtDirectNode\$allowChildren.

Referenced by ExtDirectNode\dataFromArray().

setChildNodes ( \TYPO3\CMS\Backend\Tree\TreeNodeCollection  $childNodes)

Sets the child nodes collection

Parameters
\TYPO3\CMS\Backend\Tree\TreeNodeCollection$childNodes
Returns
void

Definition at line 543 of file ExtDirectNode.php.

References ExtDirectNode\setLeaf().

setCls (   $class)

Sets the css class(es)

Parameters
string$class
Returns
void

Definition at line 417 of file ExtDirectNode.php.

Referenced by ExtDirectNode\dataFromArray().

setContextInfo (   $contextInfo)

Sets the context info

Parameters
array$contextInfo
Returns
void

Definition at line 522 of file ExtDirectNode.php.

References ExtDirectNode\$contextInfo.

Referenced by ExtDirectNode\dataFromArray().

setDraggable (   $draggable)

Sets the draggable indicator

Parameters
bool$draggable
Returns
void

Definition at line 255 of file ExtDirectNode.php.

References ExtDirectNode\$draggable.

Referenced by ExtDirectNode\dataFromArray().

setEditableText (   $editableText)

Sets the editable text

Parameters
string$editableText
Returns
void

Definition at line 324 of file ExtDirectNode.php.

References ExtDirectNode\$editableText.

Referenced by ExtDirectNode\dataFromArray().

setExpandable (   $expandable)

Sets the expandable indicator

Parameters
bool$expandable
Returns
void

Definition at line 210 of file ExtDirectNode.php.

References ExtDirectNode\$expandable.

Referenced by ExtDirectNode\dataFromArray().

setExpanded (   $expanded)

Sets the expanded indicator

Parameters
bool$expanded
Returns
void

Definition at line 231 of file ExtDirectNode.php.

References ExtDirectNode\$expanded.

Referenced by ExtDirectNode\dataFromArray().

setInCopyMode (   $inCopyMode)

Sets the paste copy indicator

Parameters
bool$inCopyMode
Returns
void

Definition at line 355 of file ExtDirectNode.php.

Referenced by ExtDirectNode\dataFromArray().

setInCutMode (   $inCutMode)

Sets the paste cut indicator

Parameters
bool$inCutMode
Returns
void

Definition at line 376 of file ExtDirectNode.php.

Referenced by ExtDirectNode\dataFromArray().

setIsDropTarget (   $isDropTarget)

Sets the indicator if the node can be a drop target

Parameters
bool$isDropTarget
Returns
void

Definition at line 276 of file ExtDirectNode.php.

References ExtDirectNode\$isDropTarget, and ExtDirectNode\isDropTarget().

Referenced by ExtDirectNode\dataFromArray().

setLabelIsEditable (   $labelIsEditable)

Sets the indicator if the label is editable

Parameters
bool$labelIsEditable
Returns
void

Definition at line 480 of file ExtDirectNode.php.

References ExtDirectNode\$labelIsEditable.

Referenced by ExtDirectNode\dataFromArray().

setLeaf (   $isLeaf)

Sets the leaf node indicator

Parameters
bool$isLeaf
Returns
void

Definition at line 189 of file ExtDirectNode.php.

Referenced by ExtDirectNode\dataFromArray(), and ExtDirectNode\setChildNodes().

setQTip (   $qtip)

Sets the quick tip

Parameters
string$qtip
Returns
void

Definition at line 438 of file ExtDirectNode.php.

References ExtDirectNode\$qtip.

Referenced by ExtDirectNode\dataFromArray().

setRecord (   $record)

Sets the database record array

Parameters
array$record
Returns
void

Definition at line 501 of file ExtDirectNode.php.

References ExtDirectNode\$record.

setSpriteIconCode (   $spriteIcon)

Sets the sprite icon code

Parameters
string$spriteIcon
Returns
void

Definition at line 459 of file ExtDirectNode.php.

Referenced by ExtDirectNode\dataFromArray().

setText (   $text,
  $textSourceField = 'title',
  $prefix = '',
  $suffix = '' 
)

Sets the label of the node with the source field and the prefix

Parameters
string$text
string$textSourceField
string$prefix
string$suffix
Returns
void

Definition at line 300 of file ExtDirectNode.php.

References ExtDirectNode\$prefix, ExtDirectNode\$suffix, and ExtDirectNode\$text.

Referenced by ExtDirectNode\dataFromArray().

setType (   $type)

Set's the node type

Parameters
string$type
Returns
void

Definition at line 168 of file ExtDirectNode.php.

References ExtDirectNode\$type.

Referenced by ExtDirectNode\dataFromArray().

toArray (   $addChildNodes = true)

Member Data Documentation

$allowChildren = true
protected
$cls = ''
protected

Definition at line 97 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getCls().

$contextInfo = array()
protected
$draggable = true
protected

Definition at line 55 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isDraggable(), and ExtDirectNode\setDraggable().

$editableText = ''
protected
$expandable = false
protected

Definition at line 48 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isExpandable(), and ExtDirectNode\setExpandable().

$expanded = false
protected

Definition at line 41 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isExpanded(), and ExtDirectNode\setExpanded().

$isDropTarget = true
protected

Definition at line 62 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isDropTarget(), and ExtDirectNode\setIsDropTarget().

$labelIsEditable = true
protected
$leaf = true
protected

Definition at line 34 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isLeafNode().

$prefix = ''
protected
$qtip = ''
protected

Definition at line 104 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getQTip(), and ExtDirectNode\setQTip().

$record = array()
protected

Definition at line 139 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getRecord(), and ExtDirectNode\setRecord().

$spriteIconCode = ''
protected

Definition at line 111 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getSpriteIconCode().

$suffix = ''
protected

Definition at line 90 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getSuffix(), and ExtDirectNode\setText().

$t3InCopyMode = false
protected

Definition at line 125 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isInCopyMode().

$t3InCutMode = false
protected

Definition at line 132 of file ExtDirectNode.php.

Referenced by ExtDirectNode\isInCutMode().

$t3TextSourceField = ''
protected

Definition at line 118 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getTextSourceField().

$text = ''
protected

Definition at line 69 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getText(), and ExtDirectNode\setText().

$type = ''
protected

Definition at line 27 of file ExtDirectNode.php.

Referenced by ExtDirectNode\getType(), and ExtDirectNode\setType().