Sitellite Application Framework
Class Tree         Index         All Elements
You are here: SAF / GUI

Packages

Cache
Cart
CGI
Database
Date
Diff
File
Functions
GUI
HTML
I18n
Loader
Mail
MailForm
Misc
Parser
Security
Session
Site
Template
XML

Classes

DataGrid
DropMenu
DropMenuItem
HtmlCell
HtmlLayout
Menu
MenuItem
Pager
Tagger

Files

Cell.php
DataGrid.php
DropMenu.php
DropMenuItem.php
Layout.php
Menu.php
MenuItem.php
Pager.php
Prompt.php
Tagger.php

Element index for package GUI

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ w ] [ x ] [ y ]

a

$addUrl
in file DataGrid.php, variable DataGrid::$addUrl
$attrs
in file Cell.php, variable HtmlCell::$attrs
    Contains all HTML <td> properties for the current object.
addChild
in file DropMenuItem.php, method DropMenuItem::addChild()
    Creates a new DropMenu class, passing on what info is required, and adding it to the child property. Note: an item may have only one child menu.
addChild
in file MenuItem.php, method MenuItem::addChild()
    Creates a new child item below the current item.
addCol
in file Layout.php, method HtmlLayout::addCol()
    Increases the number of columns by 1.
addItem
in file Menu.php, method Menu::addItem()
    Adds an item to the tree. $ref is the id of the parent item.
addItem
in file DropMenu.php, method DropMenu::addItem()
    Creates a new DropMenuItem class, passing on what info is required, and adding it to the items array.
addRow
in file Layout.php, method HtmlLayout::addRow()
    Increases the number of rows by 1.
append
in file Layout.php, method HtmlLayout::append()
    Appends more to the template of the specified child HtmlCell object. $part may be either a string of the format 'a1', or an array with two numeric values denoting the cell's x and y position.
assign
in file Layout.php, method HtmlLayout::assign()
    Assigns a template to the specified child HtmlCell object.
top

c

$cache
in file Menu.php, variable Menu::$cache
$cacheLocation
in file Menu.php, variable Menu::$cacheLocation
$cell
in file Layout.php, variable HtmlLayout::$cell
    Contains all HTML <td> properties for the current object, if this layout is not the top-level layout object.
$child
in file DropMenuItem.php, variable DropMenuItem::$child
    The child DropMenu object of this item.
$children
in file MenuItem.php, variable MenuItem::$children
    An array of child items.
$closedPic
in file Menu.php, variable Menu::$closedPic
    The path to the image to use for the'"closed' graphic in the collapsible display mode. Defaults to '/pix/false.gif'.
$collection
in file DataGrid.php, variable DataGrid::$collection
$colours
in file Menu.php, variable Menu::$colours
    A list of background colours to use to differentiate between levels in the collapsible display mode. Starts at #ffffff (white) and goes down to #999999 (medium grey) and back.
$colours
in file MenuItem.php, variable MenuItem::$colours
    An array of background colours for this item, which is the same as the $colours property of saf.GUI.Menu.
clear
in file Menu.php, method Menu::clear()
    Clears the item tree.
col
in file Layout.php, method HtmlLayout::col()
    Returns the specified column as an array of cells.
countChildren
in file Menu.php, method Menu::countChildren()
    Returns the number of child items of the specified item.
Cell.php
procedural page Cell.php
top

d

$data_col
in file Tagger.php, variable Tagger::$data_col
$data_table
in file Tagger.php, variable Tagger::$data_table
$default
in file Cell.php, variable HtmlCell::$default
    $default is an optional default value to place in cells whose templates result in no output.
$deleteUrl
in file DataGrid.php, variable DataGrid::$deleteUrl
$direction
in file DropMenu.php, variable DropMenu::$direction
    The direction the menu should open to a new level. Defaults to 'right'.
$direction
in file DropMenuItem.php, variable DropMenuItem::$direction
    The direction of the drop menu this item is a part of. Used for inheriting to a child menu.
DataGrid
in file DataGrid.php, method DataGrid::DataGrid()
DataGrid
in file DataGrid.php, class DataGrid
    Generates tables of data with automatic next/previous paging, sorting by column headers, and add/edit/delete capabilities (via linking to specified URLs. Also handles the retrieval of the data from the specified table automatically.
display
in file MenuItem.php, method MenuItem::display()
    Renders this item and those below it. $mode can be 'html' or 'collapsible'. $tplt can be a single template or an array of templates.
display
in file Tagger.php, method Tagger::display()
display
in file Menu.php, method Menu::display()
    Renders the menu. $mode can be 'html' or 'collapsible'.
draw
in file DataGrid.php, method DataGrid::draw()
DropMenu
in file DropMenu.php, method DropMenu::DropMenu()
    Constructor method.
DropMenu
in file DropMenu.php, class DropMenu
    DropMenu generates HTML and JavaScript for DHTML drop menus.
DropMenuItem
in file DropMenuItem.php, method DropMenuItem::DropMenuItem()
    Constructor method.
DropMenuItem
in file DropMenuItem.php, class DropMenuItem
    DropMenuItem provides individual menu item facilities to the DropMenu class, which generates HTML and JavaScript for DHTML drop menus.
DataGrid.php
procedural page DataGrid.php
DropMenuItem.php
procedural page DropMenuItem.php
DropMenu.php
procedural page DropMenu.php
top

e

$editUrl
in file DataGrid.php, variable DataGrid::$editUrl
$error
in file Menu.php, variable Menu::$error
    Contains the most recent error message if an error has occurred, false otherwise.
$error
in file DataGrid.php, variable DataGrid::$error
$extraMouseOut
in file DropMenuItem.php, variable DropMenuItem::$extraMouseOut
    Optional extra JavaScript to call when the item loses focus.
$extraMouseOut
in file DropMenu.php, variable DropMenu::$extraMouseOut
    Optional extra JavaScript to call in each item loses focus.
$extraMouseOver
in file DropMenu.php, variable DropMenu::$extraMouseOver
    Optional extra JavaScript to call when each item is in focus.
$extraMouseOver
in file DropMenuItem.php, variable DropMenuItem::$extraMouseOver
    Optional extra JavaScript to call when the item is in focus.
top

f

$fields
in file DataGrid.php, variable DataGrid::$fields
$fill
in file Cell.php, variable HtmlCell::$fill
    The object or associative array to use to fill the template with upon calling render().
$footer
in file DataGrid.php, variable DataGrid::$footer
fetch
in file Tagger.php, method Tagger::fetch()
filter
in file DataGrid.php, method DataGrid::filter()
top

g

getChildren
in file Menu.php, method Menu::getChildren()
    Returns the children of the specified item.
getInfo
in file Pager.php, method Pager::getInfo()
    Calculates the pager info and returns it as an associative array.
getLevel
in file Tagger.php, method Tagger::getLevel()
getList
in file DataGrid.php, method DataGrid::getList()
getList
in file DropMenu.php, method DropMenu::getList()
    Returns a list of menu names, including the current menu and all its children.
getPages
in file Pager.php, method Pager::getPages()
    Creates a two-dimensional array of pages to be displayed. The inner arrays contain the following keys:
getSections
in file Menu.php, method Menu::getSections()
    Retrieves a list of all of the items denoted as section roots.
getTree
in file Menu.php, method Menu::getTree()
    Builds the item tree from the database table specified.
top

h

$header
in file DataGrid.php, variable DataGrid::$header
$hideValue
in file Menu.php, variable Menu::$hideValue
    The value that the database column in $listcolumn is supposed to contain when a field is not to be shown. Defaults to 'no'.
homeLink
in file Menu.php, method Menu::homeLink()
    Returns a 'home' link. Called by the trail() method to add an optional 'home' link to breadcrumb trails. The home link id is always 'index', and the title is always 'Home', which can be changed or translated if a global $intl saf.I18n object is found.
HtmlCell
in file Cell.php, class HtmlCell
    HtmlCell is the individual cell class for the HtmlLayout grid class.
HtmlCell
in file Cell.php, method HtmlCell::HtmlCell()
    Constructor method.
HtmlLayout
in file Layout.php, class HtmlLayout
    HtmlLayout is an editable grid layout system using HTML tables, allowing for more complex GUIs to be developed more easily or at least in a more automated fashion.
HtmlLayout
in file Layout.php, method HtmlLayout::HtmlLayout()
    Constructor method.
top

i

$id
in file MenuItem.php, variable MenuItem::$id
    The (usually) unique id of this item.
$idcolumn
in file Menu.php, variable Menu::$idcolumn
    The name of the column in the database table that contains the primary key values.
$includedJs
in file Menu.php, variable Menu::$includedJs
    Remembers whether or not the JavaScript for the collapsible display mode has been included yet or not.
$initFunc
in file Menu.php, variable Menu::$initFunc
    The name of the JavaScript init() function for this menu.
$items
in file DropMenu.php, variable DropMenu::$items
    An array of DropMenuItem objects
$itemTemplate
in file DropMenu.php, variable DropMenu::$itemTemplate
    The template used to draw each drop menu item.
includeJavaScript
in file Menu.php, method Menu::includeJavaScript()
    Returns the HTML code to include the necessary JavaScript files for the collapsible display mode.
top

j

$jsDir
in file Menu.php, variable Menu::$jsDir
    The directory to find the JavaScript for the collapsible view in. Default is '/js'.
top

l

$limit
in file DataGrid.php, variable DataGrid::$limit
$lineHeight
in file DropMenu.php, variable DropMenu::$lineHeight
    The height of each item in the menu. Default is 19.
$lineHeight
in file DropMenuItem.php, variable DropMenuItem::$lineHeight
    The height of this item and each item in its parent drop menu.
$link
in file DropMenuItem.php, variable DropMenuItem::$link
    The URL to link this item to.
$list
in file DataGrid.php, variable DataGrid::$list
$listcolumn
in file Menu.php, variable Menu::$listcolumn
    The name of the column in the database table that says whether or not to display each record as an item.
Layout.php
procedural page Layout.php
loadConfig
in file Menu.php, method Menu::loadConfig()
    Loads the item tree from an include file or string.
top

m

$matrix
in file Layout.php, variable HtmlLayout::$matrix
    Contains the grid.
$menuWidth
in file DropMenu.php, variable DropMenu::$menuWidth
    The width of the menu.
$menuWidth
in file DropMenuItem.php, variable DropMenuItem::$menuWidth
    The width of the drop menu this item is a part of. Used for inheriting to a child menu.
$menu_tpl
in file DropMenuItem.php, variable DropMenuItem::$menu_tpl
    The menu template to use to generate child drop menus.
MenuItem.php
procedural page MenuItem.php
Menu.php
procedural page Menu.php
makeConfig
in file Menu.php, method Menu::makeConfig()
    Creates the PHP code for a config file from the item tree.
Menu
in file Menu.php, method Menu::Menu()
    Constructor method.
Menu
in file Menu.php, class Menu
    Menu is a class that is used to generate navigation systems on the fly on web sites, based on a self-referencial database table structure.
MenuItem
in file MenuItem.php, method MenuItem::MenuItem()
    Constructor method.
MenuItem
in file MenuItem.php, class MenuItem
    MenuItem is the item class that compliments the Menu class and provides much of its recursive logic.
menu_get_sections
in file Menu.php, function menu_get_sections()
    Alias of $GLOBALS['menu']->getSections().
menu_is_child_of
in file Menu.php, function menu_is_child_of()
    Determines whether the specified $child id is a child of the specified $parent id.
top

n

$name
in file DropMenu.php, variable DropMenu::$name
    The name of the menu.
top

o

$openedPic
in file Menu.php, variable Menu::$openedPic
    The path to the image to use for the'"opened' graphic in the collapsible display mode. Defaults to '/pix/true.gif'.
top

p

$parent
in file MenuItem.php, variable MenuItem::$parent
    A reference to the parent of this item, or false if there is no parent.
Pager.php
procedural page Pager.php
Prompt.php
procedural page Prompt.php
Pager
in file Pager.php, method Pager::Pager()
    Constructor method.
Pager
in file Pager.php, class Pager
    Pager is a list paging package (ie. " Previous Page | 1 | 2 | 3 | Next Page >>").
PAGER_TEMPLATE_FROM_TO
in file Pager.php, constant PAGER_TEMPLATE_FROM_TO
    Template to display "Displaying 11 to 20 of 57". Displays "No items" if there are none.
PAGER_TEMPLATE_NEXT
in file Pager.php, constant PAGER_TEMPLATE_NEXT
    Template to display "Next" link. If there is no subsequent page, displays "Next" as unlinked text.
PAGER_TEMPLATE_NEXT_PREV
in file Pager.php, constant PAGER_TEMPLATE_NEXT_PREV
    Template to display "Page 3 of 5. Previous Next". Displays "No items" if there are none.
PAGER_TEMPLATE_PAGES
in file Pager.php, constant PAGER_TEMPLATE_PAGES
    Template to display string of the form "Page 1 of 5.". Displays nothing if there are no items.
PAGER_TEMPLATE_PAGE_LIST
in file Pager.php, constant PAGER_TEMPLATE_PAGE_LIST
    Template to display page list (ie. "1 2 3 4"). Displays "No items" if there are none.
PAGER_TEMPLATE_PREV
in file Pager.php, constant PAGER_TEMPLATE_PREV
    Template to display "Previous" link. If there is no previous page, displays "Previous" as unlinked text.
PAGER_TEMPLATE_PREV_PAGE_LIST_NEXT
in file Pager.php, constant PAGER_TEMPLATE_PREV_PAGE_LIST_NEXT
    Template to display "Previous 1 2 3 Next". Displays "No items" if there are none.
primaryKey
in file DataGrid.php, method DataGrid::primaryKey()
top

q

query
in file Pager.php, method Pager::query()
    Returns a database query's results, limited by Pager's current $limit and $offset settings. Also sets the $total property and calls getInfo().
top

r

$refcolumn
in file Menu.php, variable Menu::$refcolumn
    The name of the column in the database table that makes a self-reference to the primary key, or id, column.
$remember
in file DataGrid.php, variable DataGrid::$remember
$row
in file Layout.php, variable HtmlLayout::$row
    Contains all HTML <tr> properties for the current object.
rememberValue
in file DataGrid.php, method DataGrid::rememberValue()
render
in file Layout.php, method HtmlLayout::render()
    Renders this layout and all of its cells as well.
render
in file Cell.php, method HtmlCell::render()
    Renders this cell into an HTML <td> tag filled with
row
in file Layout.php, method HtmlLayout::row()
    Returns the specified row as an array of cells.
top

s

$showcolumn
in file Menu.php, variable Menu::$showcolumn
    The name of the column in the database table that is to be displayed.
$sitelliteAllowed
in file Menu.php, variable Menu::$sitelliteAllowed
    Specifies whether or not to use the global $sitellite object (from the Sitellite CMS-only package saf.App.Conf.Sitellite) to add automatic permission limits on the database query. For more information, see saf.App.Conf.Sitellite in DocReader.
$skipHeaders
in file DataGrid.php, variable DataGrid::$skipHeaders
$sortcolumn
in file Menu.php, variable Menu::$sortcolumn
    The field to sort by, in case of a sort field. A sort field outweighs the default sorting alphabetically.
$sortorder
in file Menu.php, variable Menu::$sortorder
    The sort order, either 'ASC' (ascending) or 'DESC' (descending).
$span
in file Cell.php, variable HtmlCell::$span
    The span of this cell. Set to -1 and the cell will disappear. Use $this->attrs['colspan'] or ['rowspan'] to set these properties in the corresponding HTML <td> tag.
section
in file Menu.php, method Menu::section()
    Returns a section of the item tree, rendered as an XHTML-compliant
set
in file Layout.php, method HtmlLayout::set()
    Increases the number of columns by 1. Note that $part may be either 'table', 'row', or 'cell' to refer to internal properties, or 'a1, a2, etc' or an array of x and y to refer to pass the property/value pair on to the set() method of individual cells.
set
in file Cell.php, method HtmlCell::set()
    Sets the appropriate key/value pair in $attrs.
setAddUrl
in file DataGrid.php, method DataGrid::setAddUrl()
setData
in file Pager.php, method Pager::setData()
    This method allows you to set external data instead of using the query() method. Note that you must set $total and call update() yourself after calling this method.
setDeleteUrl
in file DataGrid.php, method DataGrid::setDeleteUrl()
setEditUrl
in file DataGrid.php, method DataGrid::setEditUrl()
setUrl
in file Pager.php, method Pager::setUrl()
    Special setter for the $url property. Accepts a variable number
skipHeader
in file DataGrid.php, method DataGrid::skipHeader()
spanCols
in file Layout.php, method HtmlLayout::spanCols()
    Sets the colspan on the specified cell, and set the cells that would be in the way to false. $num is the colspan.
spanRows
in file Layout.php, method HtmlLayout::spanRows()
    Sets the rowspan on the specified cell, and set the cells that would be in the way to false. $num is the rowspan.
sub
in file Layout.php, method HtmlLayout::sub()
    Create and return a sub HtmlLayout object in the
top

t

$table
in file Layout.php, variable HtmlLayout::$table
    Contains all HTML <table> properties for the current object.
$table
in file Menu.php, variable Menu::$table
    The name of the database table (if any) that this menu is being pulled from.
$tag_col
in file Tagger.php, variable Tagger::$tag_col
$tag_table
in file Tagger.php, variable Tagger::$tag_table
$tag_table_key
in file Tagger.php, variable Tagger::$tag_table_key
$template
in file DataGrid.php, variable DataGrid::$template
$template
in file DropMenuItem.php, variable DropMenuItem::$template
    The template to use to generate the menu item.
$template
in file DropMenu.php, variable DropMenu::$template
    The template used to draw the drop menu DIV.
$template
in file Cell.php, variable HtmlCell::$template
    Contains the template to use to fill this cell with upon calling render().
$text
in file DropMenuItem.php, variable DropMenuItem::$text
    The text of the menu item.
$title
in file MenuItem.php, variable MenuItem::$title
    The title of this item.
$total
in file DataGrid.php, variable DataGrid::$total
$tree
in file Menu.php, variable Menu::$tree
    Contains a multi-dimensional array of MenuItem objects.
$type
in file DataGrid.php, variable DataGrid::$type
Tagger.php
procedural page Tagger.php
Tagger
in file Tagger.php, method Tagger::Tagger()
Tagger
in file Tagger.php, class Tagger
    Generates a series of tag names linking to a source of data. The names are alphabetical and organized into 6 different sizes so as to visually display which tags contain the most data.
trail
in file Menu.php, method Menu::trail()
    Generates a breadcrumb trail from the start of the tree to the specified item, returned as an array of template-rendered items. If $home is true, add a 'home' link by calling the homeLink() method.
trail
in file MenuItem.php, method MenuItem::trail()
    Creates a breadcrumb trail as an array of item objects.
translate
in file Layout.php, method HtmlLayout::translate()
    Translates between the 'a1, a2, b1, b2' notation and the array (0, 0), array (0, 1), array (1, 0), array (1, 1) notation.
top

u

$url
in file Pager.php, variable Pager::$url
    URL prefix for pager links.
update
in file Pager.php, method Pager::update()
    Alias for getInfo().
top

w

walk
in file Layout.php, method HtmlLayout::walk()
    Returns the entire grid as an array of cells, going top-to-bottom, then left-to-right.
write
in file DropMenuItem.php, method DropMenuItem::write()
    Writes the drop menu item, as well as any child menus, and returns it as a string. The 'show' property is for internal use, as this method may be called again by one of the items inside this child's menu if it has any child menus.
write
in file DropMenu.php, method DropMenu::write()
    Writes the drop menu div and returns it as a string. The 'show' property is for internal use, as this method may be called again by one of the items inside this menu if it has any child menus.
top

x

$xpos
in file Menu.php, variable Menu::$xpos
    The distance from the left edge of the browser window to display the menu in collapsible display mode. Default is 0.
$xpos
in file DropMenuItem.php, variable DropMenuItem::$xpos
    The x position of the drop menu this item is a part of. Used for inheriting to a child menu.
$xpos
in file DropMenu.php, variable DropMenu::$xpos
    The x position of the top-left corner of the menu.
top

y

$ypos
in file Menu.php, variable Menu::$ypos
    The distance from the top edge of the browser window to display the menu in collapsible display mode. Default is 0.
$ypos
in file DropMenuItem.php, variable DropMenuItem::$ypos
    The y position of the drop menu this item is a part of. Used for inheriting to a child menu.
$ypos
in file DropMenu.php, variable DropMenu::$ypos
    The y position of the top-left corner of the menu.
top
Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:16:32 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2