PhpExt : Config [ class tree ] [ index ] [ all elements ]

Class: PhpExt_ToolConfigObject

Source Location: /PhpExt/ToolConfigObject.php

Class PhpExt_ToolConfigObject

Method Summary
PhpExt_JavascriptStm   getHandler()   The function to call when clicked. Arguments passed are:
boolean   getHidden()   True to initially render hidden.
string   getId()   The type of tool to create. Values may be
PhpExt_ListenerCollection   getOn()   A PhpExt_ListenerCollection
string   getQtip()   A tip string, or a config argument to Ext.QuickTip.register
JavascriptStm   getScope()   The scope in which to call the handler.
PhpExt_ToolConfigObject   __construct()  
PhpExt_ToolConfigObject   setHandler()   The function to call when clicked. Arguments passed are:
PhpExt_ToolConfigObject   setHidden()   True to initially render hidden.
PhpExt_ToolConfigObject   setId()   The type of tool to create. Values may be
PhpExt_ToolConfigObject   setOn()   A PhpExt_ListenerCollection
PhpExt_ToolConfigObject   setQtip()   A tip string, or a config argument to Ext.QuickTip.register
PhpExt_ToolConfigObject   setScope()   The scope in which to call the handler.

[ Top ]
Methods
getHandler  [line 134]

  PhpExt_JavascriptStm getHandler( )

The function to call when clicked. Arguments passed are:

<dl> <dt>event : Ext.EventObject</dt> <dd>The click event.</dd> <dt>toolEl : Ext.Element</dt> <dd>The tool Element.</dd> <dt>Panel : Ext.Panel<dt> <dd>The host Panel</dd> </dl>


API Tags:
Access:  public


[ Top ]
getHidden  [line 188]

  boolean getHidden( )

True to initially render hidden.


API Tags:
Access:  public


[ Top ]
getId  [line 98]

  string getId( )

The type of tool to create. Values may be


API Tags:
Access:  public


[ Top ]
getOn  [line 206]

A PhpExt_ListenerCollection


API Tags:
Access:  public


[ Top ]
getQtip  [line 170]

  string getQtip( )

A tip string, or a config argument to Ext.QuickTip.register


API Tags:
Access:  public


[ Top ]
getScope  [line 152]

  JavascriptStm getScope( )

The scope in which to call the handler.


API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 219]

  PhpExt_ToolConfigObject __construct( string $id, PhpExt_JavascriptStm $handler, [boolean $scope = null], [string $qtip = null], [string $hidden = null], [PhpExt_ListenerCollection $on = null]  )

Parameters:
string   $id:  The type of tool to create. For a list of possible values see PhpExt_Tool::setId().
PhpExt_JavascriptStm   $handler:  The Javacript function to call when clicked, can be created with PhpExt_Javascript::functionDef()
boolean   $scope:  The scope in which to call the handler.
string   $qtip:  A tip string, or a config argument to Ext.QuickTip.register
string   $hidden:  True to initially render hidden.
PhpExt_ListenerCollection   $on:  A PhpExt_ListenerCollection

API Tags:
Access:  public


Redefinition of:
PhpExt_Config_ConfigObject::__construct()

[ Top ]
setHandler  [line 117]

  PhpExt_ToolConfigObject setHandler( PhpExt_JavascriptStm $value  )

The function to call when clicked. Arguments passed are:

<dl> <dt>event : Ext.EventObject</dt> <dd>The click event.</dd> <dt>toolEl : Ext.Element</dt> <dd>The tool Element.</dd> <dt>Panel : Ext.Panel<dt> <dd>The host Panel</dd> </dl>

Parameters:
PhpExt_JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
setHidden  [line 180]

  PhpExt_ToolConfigObject setHidden( boolean $value  )

True to initially render hidden.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setId  [line 71]

  PhpExt_ToolConfigObject setId( string $value  )

The type of tool to create. Values may be

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setOn  [line 198]

A PhpExt_ListenerCollection

Parameters:
PhpExt_ListenerCollection   $value: 

API Tags:
Access:  public


[ Top ]
setQtip  [line 162]

  PhpExt_ToolConfigObject setQtip( string $value  )

A tip string, or a config argument to Ext.QuickTip.register

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setScope  [line 144]

  PhpExt_ToolConfigObject setScope( JavascriptStm $value  )

The scope in which to call the handler.

Parameters:
JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
Constants
ID_CLOSE = 'close' [line 26]

[ Top ]
ID_DOWN = 'down' [line 36]

[ Top ]
ID_GEAR = 'gear' [line 30]

[ Top ]
ID_HELP = 'help' [line 40]

[ Top ]
ID_LEFT = 'left' [line 34]

[ Top ]
ID_MAXIMIZE = 'maximize' [line 28]

[ Top ]
ID_MINIMIZE = 'minimize' [line 27]

[ Top ]
ID_MINUS = 'minus' [line 38]

[ Top ]
ID_PIN = 'pin' [line 31]

[ Top ]
ID_PLUS = 'plus' [line 39]

[ Top ]
ID_REFRESH = 'refresh' [line 37]

[ Top ]
ID_RESTORE = 'restore' [line 29]

[ Top ]
ID_RIGHT = 'right' [line 33]

[ Top ]
ID_SAVE = 'save' [line 42]

[ Top ]
ID_SEARCH = 'search' [line 41]

[ Top ]
ID_TOOGLE = 'toogle' [line 25]

[ Top ]
ID_UNPIN = 'unpin' [line 32]

[ Top ]
ID_UP = 'up' [line 35]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:01:38 -0500 by phpDocumentor 1.4.0