| javascript_plugins

# Class: Bs_InstantToolTip Source Location: /plugins/instanthelp/Bs_InstantToolTip.class.js.php
### Class Overview
Bs_InstantToolTip class #### Author(s): andrej at arn dot li #### Copyright: blueshoes.org | ### Variables $eventX $eventY $highlightCursor $highlightMode $mode $rasterImage $toolTipLayerContentId $toolTipLayerId $_layerLeftDown $_layerLeftUp $_layerRightUp | ### Methods fireToolTip init query release start _initLayerLeftDown _initLayerLeftUp _initLayerRightDown _initLayerRightUp
### Inherited Variables | ### Inherited Methods
### Class Details [line 16] Bs_InstantToolTip class dependencies: Bs_InstantHelpClient, Bs_Misc.lib.js #### Tags:
copyright: | blueshoes.org
author: | andrej at arn dot li
[ Top ] ### Class Variables #### $eventX = false [line 41]
Type: | mixed
[ Top ] #### $eventY = false [line 46]
Type: | mixed
[ Top ] #### $highlightCursor = 'help' [line 57] defines what cursor should be used when the mouse oves over something for what a tooltip is available. by default it is set to 'help' (css 2). can also be set to 'hand' (ie uses 'hand', for mozilla the property 'pointer' will be used). #### Tags:
var: | cursor
since: | bs4.3
access: | public
Type: | string
[ Top ] #### $highlightMode = 'border' [line 78] defines the default highlight mode. can be a string or a hash. possible options are: 'border' (default), 'background', 'raster'. example 1: obj.highlightMode = 'raster'; example 2: obj.highlightMode = new Array(); obj.highlightMode['border'] = true; obj.highlightMode['raster'] = true; check the howto to see how they look. note that this default can be overwritten for each element that defines a tooltip. again, check the howto. #### Tags:
var: | highlightMode
access: | public
Type: | string
[ Top ] #### $mode = false [line 36] if we're in tooltip mode or not.
Type: | mixed
[ Top ] #### $rasterImage = '/_bsImages/plugins/instanthelp/raster/yellow400.gif' [line 86] if this.highlightMode is set to 'raster' then this raster image will be used. #### Tags:
var: | rasterImage
since: | bs4.3
access: | public
Type: | string
[ Top ] #### $toolTipLayerContentId = 'tthLayerContent' [line 95]
Type: | mixed
[ Top ] #### $toolTipLayerId = 'tthLayer' [line 94] the id of the tooltip layer. you may change this if needed. for example if you want to use 2 different (looking) tooltips on the same page. but normally there's no need. #### Tags:
var: | toolTipLayerId
Type: | string
[ Top ] #### $_layerLeftDown = [line 105]
Type: | mixed
[ Top ] #### $_layerLeftUp = [line 107]
Type: | mixed
[ Top ] #### $_layerRightUp = [line 106]
Type: | mixed
[ Top ] ### Class Methods ### method fireToolTip [line 311]
`void fireToolTip( string value)`
fires when the text from instanthelp came back from the server. #### Parameters:
string | value | value
[ Top ] ### method init [line 115]
`void init( string objectName, object ih ih)`
#### Tags:
access: | public
#### Parameters:
string | objectName | objectName (name of this object, eg 'itt'. note: needs to be in the global scope so everyone can call it.)
object ih | ih | (instance of Bs_InstantHelp)
[ Top ] ### method query [line 272]
`bool query( object obj obj, object event event)`
executes a query if we're in query mode. we return false if the query has been done because you can use that value in your code to return it too. then other events won't fire because of the return false. you may not understand this if you're not a web crack, just accept that it works like that. #### Tags:
return: | (false if query has been done, true if not. see above.)
access: | public
#### Parameters:
object obj | obj |
object event | event | (event object, msie)
[ Top ] ### method release [line 221]
`void release( )`
release the tool tip help. that means: hide the tool tip, and make the elements (words, icons, whatever) not marked as tooltipable anymore. (yellow border, whatever) #### Tags:
see: | Bs_InstantToolTip::start()
access: | public
[ Top ] ### method start [line 127]
`void start( )`
opposite of release #### Tags:
see: | Bs_InstantToolTip::release()
access: | public
[ Top ] ### method _initLayerLeftDown [line 500]
`void _initLayerLeftDown( )`
[ Top ] ### method _initLayerLeftUp [line 542]
`void _initLayerLeftUp( )`
[ Top ] ### method _initLayerRightDown [line 479]
`void _initLayerRightDown( )`
[ Top ] ### method _initLayerRightUp [line 521]
`void _initLayerRightUp( )`
[ Top ] Documentation generated on Mon, 29 Dec 2003 22:18:25 +0100 by phpDocumentor 1.2.3