Tool Tip

Creates a pretty tooltip / speech bubble using qTip.

Tag Attributes

<ss:standard:tooltip />

Events=""
When set to true, the tooltip will not hide if moused over, allowing the
contents to be clicked and interacted with.

ContentTitle=""
Content of the tooltip

ContentText=""
Content of the tooltip

StyleClasses=""
A space separated string containing all class names which should be added
to the main qTip element

PreRender=""
By default, tooltips are rendered on thier first show event, rather than
on page load. Setting this to true will cause tooltips to be created on page load.

Overwrite=""
Determines if, then the .
qtip() method is called on an element with a qTip already present, the new one overrides (i.e. destroys) the old one. By default this is true.

Suppress=""
Determines whether or not the default browser tooltips are suppressed for
the selectors elements when the qTip is created.

PositionTarget=""
HTML element the tooltip will be positioned in relation to.

PositionMy=""
The corner of the tooltip to position in relation to the position.at

PositionAt=""
The corner of the position.target element to position the tooltips corner
at.

PositionAdjustX=""
A positive or negative pixel value by which to offset the tooltip in the
horizontal plane e.g. the x-axis

PositionAdjustY=""
A positive or negative pixel value by which to offset the tooltip in the
vertical plane e.g. the y-axis

PositionAdjustMethod=""
This option determines the kind of viewport positioning that takes place.

ShowTarget=""
Defines the HTML element(s) which will trigger your specified
show.event(s). When set to false, the element the .qtip() method was called upon is used.

ShowEvent=""
Event(s) which will trigger the tooltip to be shown.
All possible values are documented under jQuery's Event bind() documentation. Multiple, space separated events are supported.

ShowDelay=""
Time in milliseconds by which to delay showing of the tooltip when the
show.event is triggered on the show.target

ShowReady=""
Determines whether or not the tooltip is shown once the document is
loaded e.g. when the document.ready() event is triggered

HideTarget=""
Defines the HTML element(s) which will trigger your specified
hide.event(s). When set to false, the element the .qtip() method was called upon is used.

HideEvent=""
Event(s) which will trigger the tooltip to be hidden.
All possible values are documented under jQuery's Event bind() documentation. Multiple, space separated events are supported.

HideDelay=""
Time in milliseconds by which to delay hiding of the tooltip when the
hide.event is triggered on the hide.target

HideInactive=""
Time in milliseconds in which the tooltip should be hidden if it remains
inactive e.g. isn't interacted with. If set to false, tooltip will not hide when inactive.

HideFixed=""
When set to true, the tooltip will not hide if moused over, allowing the
contents to be clicked and interacted with.

HideLeave=""
Additional hide setting that allows you to specify whether the tooltip
will hide when leaving the window it's contained within. This option requires you to be using either mouseout or mouseleave as (one of) your hide events.

HideDistance=""
This setting allows you to determine the distance after which the tooltip
hides when the mouse is moved from the point it triggered the tooltip. This is what the regular browser tooltips behave like.

Width=""
Sets the width of the element

Height=""
Sets the height of the element

Id=""
Sets id of the object - used for the html id attribute and referencing in the parser's
document object model

AttributeSet=""
Calls setAttribute() for each key value pair in $arrAttributes

AjaxModified=""
Sets whether or not this object is modified by ajax requests

AjaxEventParameter=""
Sets a parameter which can be passed to the ajax event
Be careful with security on this parameter as it is passed through javascript in the clients browser.

ChildNodes=""
Sets the children of this node in the DOM

InnerText=""
Adds a new TextNode child at the end of the children

Class Methods

The following methods can be invoked on instances of this class.

__construct()

Constructor

getNodeName()

getNodeDisplayType()

getRequiresId()

initialize()

renderTagContents()

renderTagClose()

__sleep()

getTagNameHTML()

Returns the base tag name

getTagNameClosedInline()

Returns whether the tag is closed inline

setWidth(mixed strWidth)

Sets the width of the element

getWidth()

Returns the width of the element

setHeight(mixed strHeight)

Sets the height of the element

getHeight()

Returns the height of the element

getJSAttributes()

Returns a set of JavaScript attributes that differ from the default JS implementation
Default values on properties can be specified by @js_attribute and @js_default

onDOMReady()

getAttributesString(mixed arrOverrides, mixed bId, bool bSize)

Returns the attributes of the elment as a renderable properties string

generateId()

Generates an id for the node if one isnt already set

getRequiresContainerDiv()

Returns whether or not this control will be wrapped in a container span

renderTagOpen(mixed arrAttributes)

Renders the opening tag

RestoreControlFromState(string strId)

Restores a control from its element state

setId(string strId)

Sets id of the object - used for the html id attribute and referencing in the parser's
document object model

getId()

Returns the id of the object

__get(string strName)

Overload for returning an attribute

__set(mixed strName, string strValue)

Overload for setting an attribute

__isset(string strName)

Returns whether an attribute exists

__unset(string strName)

Removes an attribute

__destruct()

setAttribute(mixed strAttribute, string strValue, mixed bDecode)

Sets an attribute
Returns true when handled Returns false when set as standard a HTML attribute

setAttributes(array arrAttributes)

Calls setAttribute() for each key value pair in $arrAttributes

setAttributesHTML(array arrAttributes)

Sets generic HTML attributes not specified by attributes of this control

getAttributesHTML(array arrAttributes)

Returns the current attributes set that aren't defined attributes of this control

setAttributeHTML(mixed strAttribute, mixed strValue)

Sets a single attribute

getAttributeHTML(mixed strAttribute)

Returns a single attribute

setAttributeJSAdd(mixed strAttrib, mixed strValue)

Adds a javascript handler attribute
If a handlers already exist, the new handler added to the end

getAttribute(mixed strAttribute)

Returns the value of the given attribute

removeAttribute(string strAttrib)

Removes an attribute

getAttributes()

Returns the objects attributes as an associative array

requireAttribute(mixed strAttribute, mixed strValue)

setAttributesParsedInit(mixed arrAttributes)

getAttributesParsedInit()

setAttributesParsedRender(mixed arrAttributes)

getAttributesParsedRender()

mergeAttributes(mixed arr1, array arr2)

Merges two sets of attributes

getStyles()

setStyle(mixed strStyle, mixed strValue)

setStyles(mixed arrStyles)

setAjaxModified(bool bAjaxModified)

Sets whether or not this object is modified by ajax requests

getAjaxModified()

Returns whether or not this object is modified by ajax requests

stateGetSavableProperties()

Returns a list of properties which will be saved to session state

stateGetSavablePropertiesAllAttributes()

Returns a list of all attributes to save to session state

stateSave()

Serializes the state of the object to session

stateSaveAdditional(mixed strKey, string strValue)

Sets a key value pair for saving additional state data
This data is handled manually by each inheriting control

stateIsSetAdditional(string strKey)

Returns whether an additional state key has been set

stateGetAdditional(string strKey)

Returns the value of a key in the additional state set
Note: This function returns a reference

stateUnsetAdditional(string strKey)

Deletes additional saved data

stateSaveAdditionalArray(mixed strKey, mixed strKey2, mixed strValue)

Sets an inner array key value pair for saving additional state data

stateIsSetAdditionalArray(mixed strKey, string strKey2)

Returns whether an additional state key has been set

stateGetAdditionalArray(mixed strKey, string strKey2)

Returns an inner array key value pair for additional state data

stateGetPrevious()

Returns the state data for the current object

stateRenderJSGetContents()

stateRenderJS()

stateRestore(mixed arrAttributes)

Restores the saved state of this object from the users session

addEventHandler(mixed strEventName, mixed strCode)

Adds an event handler
If $strCode is an array, call_user_func_array will be called directly call_user_func_array($strFunc[0], $strFunc[1]);

removeEventHandler(mixed strEventName)

triggerEvent(string strEventName)

Triggers a server side event
Calls all event handlers set by addEventHandler

setEventHandlersAjax(array arrHandlers)

Sets the ajax event handlers

addEventHandlerAjax(mixed strEventName, mixed strAjaxEventId)

Adds an AJAX event handler

getEventHandlersAjax()

Sets the ajax event handlers

setAjaxEventParameter(string strParameter)

Sets a parameter which can be passed to the ajax event
Be careful with security on this parameter as it is passed through javascript in the clients browser.

getAjaxEventParameter()

Returns the current ajax event parameter

getIsAjax()

callDelegate(string strFunc)

Trigger an event by evaluating the script in $strFunc

onDOMReadySetParsedAttributes()

onDOMReadySetParsedAttributesAJAX()

render()

Renders the element

renderAJAXTree(mixed bInside)

__sleepExport()

Magic function for a better var_export() of nodes

__wakeup()

Wake up

__clone()

Clone

__toString()

Renders the element to a string

getTrimContents()

Returns whether the control should trim its contents for optimisation purposes

setParentNode(\Framework\DOM\Nodes\NodeABC pNode)

Sets the elements parent node in the DOM

getParentNode()

Returns the elements parent node in the DOM

getAscendant(string strAscendantClass)

Returns the first ascendant node of a specific class

getDocument()

Returns the elements top most / document element

setChildNodesFromTemplate(array arrChildNodes)

Sets the child nodes from the template
This method may be overridden if the innerHTML from the original source acts as a template, rather than being the nodes themselves. For example, a data repeater uses the child nodes from the template to construct the child nodes dynamically.

setChildNodes(array arrChildNodes)

Sets the children of this node in the DOM

getChildNodes()

Returns the children of this node

insertBefore(mixed pNewNode, mixed pNode)

insertAfter(mixed pNewNode, mixed pNode)

appendChild(\Framework\DOM\Nodes\NodeABC pNode)

Adds new child at the end of the children

appendChildText(mixed strText)

Adds a new TextNode child at the end of the children

removeChild(\Framework\DOM\Nodes\NodeABC pNode)

Removes the specified node from the list of children

debugRenderChildren(mixed iDepth)

resetDOMStates()

Resets the indicators for dom states so that reinitialisation / rendering can occur

uiStateGetParentVars()

Returns an array containing the states of parent controls
such as DialogBox and TabList

__call(mixed strName, array arrArguments)

Magic function to trap calls to undefined functions and throw an exception rather than
a fatal error.

__callStatic(mixed strName, array arrArguments)

Magic function to trap static calls to undefined functions and throw an exception rather
than a fatal error.

classGetFolder()

Returns the folder where the class exists

__set_state(mixed arrValues)

classGetFolderResources()

Returns the folder where the class's resources exist

classGetSrcFile()

Returns the folder where the class exists

classGetSrcHash()

Returns the folder where the class exists

classGetReflection()

Returns the reflection data for the current class

classGetReflectionAnnotation(string strField)

Returns a specific class annotation for the current class