Inherited Variables
Inherited Constants
Inherited Methods
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - UI Frames
This class provides frame support. Frames are containers which can hold multiple widgets.
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$disabled = false
[line 98]
Frame Disabled Flag
Tags:
- var - Frame disabled
- access - public
Type: boolean
Overrides:
[ Top ]
$id = null
[line 71]
Frame ID
Tags:
- var - Item title
- access - public
Type: string
Overrides:
[ Top ]
$visible = true
[line 107]
Frame Visible Flag
Tags:
- var - Frame visible
- access - public
Type: boolean
Overrides:
[ Top ]
$_id = null
[line 116]
Frame Id
Tags:
- var - Frame Id
- access - public
Type: string
Overrides:
[ Top ]
$_items = array()
[line 62]
Child items
Tags:
- var - Child items
- access - protected
Type: array
Overrides:
[ Top ]
Class Methods
static createFrame
static VUIFrame &createFrame(
)
[line 219]
Create a new frame
Tags:
- return - Frame
- access - public
Parameters:
[ Top ]
static getFrameList
static void getFrameList(
[boolean
$onlyloaded = false])
[line 271]
List all frames
Tags:
- access - public
Parameters:
- boolean $onlyloaded - Only list loaded frames
[ Top ]
static getInstance
static VUIFrame &getInstance(
[$frameID
$frameID = null])
[line 301]
Get instance of a frame
Tags:
- return - Frame
Parameters:
- $frameID $frameID - Frame ID
[ Top ]
delete
boolean|object True delete(
)
[line 400]
Delete Frame
Tags:
- return - on success, error or warning otherwise
- access - public
Overrides VObject::delete() (Delete Object)
Parameters:
[ Top ]
deleteItem
boolean|object True deleteItem(
integer
$idx)
[line 433]
Delete Item
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- integer $idx - Item index
[ Top ]
getItem
VUIFrameItem|object Frame &getItem(
integer
$idx)
[line 416]
Get an item by index
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- integer $idx - Index
[ Top ]
getProperties
array getProperties(
[boolean
$public = true])
[line 126]
Get item properties
Tags:
- return - Item properties
- access - public
Overrides VObject::getProperties() (Get object properties)
Parameters:
- boolean $public - Return only public properties
[ Top ]
insertItem
integer insertItem(
array|object
$item, [integer
$before = null])
[line 234]
Insert item
Tags:
- return - item index
Parameters:
- array|object $item - Item
- integer $before - Before ID
[ Top ]
load
boolean|object True load(
string
$filename)
[line 342]
Load a menu from menu file
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- string $filename - Menu filename
[ Top ]
replaceItem
void replaceItem(
integer
$idx, VUIFrameItem
$item)
[line 458]
Replace item
Tags:
- access - public
Parameters:
- integer $idx - Item index
- VUIFrameItem $item - New item
[ Top ]
save
void save(
[string
$filename = null])
[line 374]
Save Frame to file
Tags:
- access - public
Overrides VObject::save() (Save Object)
Parameters:
- string $filename - Filename
[ Top ]
_loadNode
void _loadNode(
object
$node)
[line 187]
Load node from document
Tags:
- access - protected
Parameters:
- object $node - Document node
[ Top ]
_saveNode
void _saveNode(
DOMDocument
$doc, DOMNode
$node, [integer
$depth = 1])
[line 147]
Save Node
Tags:
- access - protected
Parameters:
- DOMDocument $doc -
- DOMNode $node -
- integer $depth - Node depth
[ Top ]