phpDocumentor epesi-utils
tabbed-browser
[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]

Class: Utils_TabbedBrowser

Source Location: /modules/Utils/TabbedBrowser/TabbedBrowser_0.php

Class Utils_TabbedBrowser

Class Overview

TabbedBrowser class.

This class facilitates grouping page content in different tabs.

Located in /modules/Utils/TabbedBrowser/TabbedBrowser_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --Module
         |
         --Utils_TabbedBrowser
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, Telaxus LLC
License:  MIT

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Module

Module::$children
Module::$display_func
Module::$parent

Inherited From Module

Module::__construct()
Constructor. Should not be called directly using new Module('name').
Module::call_callback_href()
Module::clear_module_variables()
Unset all module variables.
Module::create_back_href()
Creates link that will lead back to previous page content.
Module::create_back_href_js()
Module::create_callback_href()
Creates link similar to link created with create_href.
Module::create_callback_href_js()
Creates link similar to link created with create_href.
Module::create_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_callback_href_with_id_js()
Creates link similar to links created with create_href.
Module::create_confirm_callback_href()
Creates link similar to link created with create_href.
Module::create_confirm_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_confirm_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_confirm_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_href_js()
Create onClick action string destined for js code.
Module::create_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_unique_href_js()
Create onClick action string destined for js code.
Module::create_unique_key()
Returns unique key name, generated from unique name of this module (function get_path) and string parameter.
Module::displayed()
Returns whether this module instance was already displayed.
Module::display_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::freeze_module()
Makes child module to not loose its module variables
Module::get_child()
Gets child module with specified node id.
Module::get_children()
Gets array of children modules.
Module::get_html_of_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::get_instance_id()
Returns id of module instance.
Module::get_jses()
Returns list of jses to evaluate.
Module::get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as second parameter.
Module::get_module_variable_or_unique_href_variable()
Returns href variable.
Module::get_node_id()
Get node identifier.
Module::get_parent_path()
Returns unique path of parent module.
Module::get_parent_type()
Returns name(type) of parent module.
Module::get_path()
Returns unique path of calling module.
Module::get_reload()
Returns current reload settings.
Module::get_unique_href_variable()
Returns variable passed with create_unique_href.
Module::init_module()
Creates module instance which name is given as first parameter.
Module::isset_module_variable()
Checks if variable exists.
Module::isset_unique_href_variable()
Checks if variable given as first parameter was passed with create_unique_href function.
Module::is_back()
Checks if set_back_location was used.
Module::is_fast_process()
Returns whether this module instance has fast processing turned on.
Module::is_inline_display()
Returns whether this module instance is displayed inline.
Module::js()
Appends js code to list of jses to evaluate.
Module::mark_displayed()
Marks this module instance as it was displayed.
Module::pack_module()
Creates instance of module given as first parameter as a child of the module that has called this function.
Module::register_method()
Module::set_back_location()
Sets reload location to previous page display.
Module::set_fast_process()
Enable fast processing for this module instance.
Module::set_inline_display()
Changes display behavior for this module instance to inline.
Module::set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::set_reload()
Mark module to force its reload or prevent being reloaded.
Module::share_module_variable()
Share variable passed as first parameter with module passed as second parameter.
Module::share_unique_href_variable()
Share href variable passed as first parameter with module passed as second parameter.
Module::static_get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as third parameter.
Module::static_isset_module_variable()
Checks if variable exists.
Module::static_set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::static_unset_module_variable()
Module::unset_module_variable()
Unset module variable.
Module::unset_unique_href_variable()
Unsets *unique_href variable.
Module::__call()

Inherited From ModulePrimitive

ModulePrimitive::__construct()
ModulePrimitive::check_access()
Checks access to function which name is passed as first parameter.
ModulePrimitive::create_data_dir()
Creates default data directory for module. Typical usage: in module installation
ModulePrimitive::get_data_dir()
Returns path to the default data directory for module calling this method.
ModulePrimitive::get_module_dir()
Returns path to the module directory.
ModulePrimitive::get_type()
Returns name(type) of module that called this function.
ModulePrimitive::get_type_with_bt()
ModulePrimitive::remove_data_dir()
Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()
ModuleAcl::add_aco()
ModuleAcl::del_aco()
ModuleAcl::get_type()

[ Top ]
Method Summary
void   body()   Displays tabs.
void   construct()  
void   end_tab()  
void   get_tab()  
void   set_default_tab()   Sets default tab.
void   set_tab()   Creates new tab.
void   start_tab()  
void   switch_tab()   This method will force Tabbed Browser to switch to selected tab.
void   tag()   Perform operation that guarantee module reloading.

[ Top ]
Methods
body  [line 39]

  void body( [string $template = null]  )

Displays tabs.

You can alternatively choose to use different template file for tabs display.

Parameters:
string   $template:  template file that will be used

API Tags:
Access:  public


[ Top ]
construct  [line 22]

  void construct( )


API Tags:
Access:  public


[ Top ]
end_tab  [line 142]

  void end_tab( )


API Tags:
Access:  public


[ Top ]
get_tab  [line 117]

  void get_tab( )


API Tags:
Access:  public


[ Top ]
set_default_tab  [line 128]

  void set_default_tab( intereger $i  )

Sets default tab.

No action will be done if tabbed browser was already displayed at least once.

Parameters:
intereger   $i:  tab number

API Tags:
Access:  public


[ Top ]
set_tab  [line 99]

  void set_tab( string $caption, method $function, [ $args = array()], [ $js = false]  )

Creates new tab.

You need to specify tab caption and what function should be called. The rest of the arguments will be passed to the function.

Parameters:
string   $caption:  tab caption
method   $function:  method that will be called when tab is displayed
   $args: 
   $js: 

API Tags:
Access:  public


[ Top ]
start_tab  [line 137]

  void start_tab( $caption  )

Parameters:
   $caption: 

API Tags:
Access:  public


[ Top ]
switch_tab  [line 110]

  void switch_tab( intereger $i  )

This method will force Tabbed Browser to switch to selected tab.

Parameters:
intereger   $i:  tab number

API Tags:
Access:  public


[ Top ]
tag  [line 87]

  void tag( )

Perform operation that guarantee module reloading.

You need to call this function from within your module to make Tabbed Browser work properly.


API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:46:41 -0500 by phpDocumentor 1.4.2