Class SweetDevRia.ClickToOpen

ClickToOpen.
Defined in: ClickToOpen.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SweetDevRia.ClickToOpen(id, shiftX, shiftY)

Field Summary
Field Attributes	Field Name and Description
	autoClose Do I need to harm the timer to check if referer link has moved ?
<static>	SweetDevRia.ClickToOpen.CLOSE_EVENT This event type is fired when close the clicktoopen component
<static>	SweetDevRia.ClickToOpen.OPEN_EVENT This event type is fired when open the clicktoopen component
	refererPosX Initial referer X position.
	refererPosY Initial referer Y position.
	refererTimerChecker Timer ID wich check if referer has moved.

Method Summary
Method Attributes	Method Name and Description
	afterClose() This method is called after closing the tooltip.
	afterOpen(aLink) This method is called after opening the tooltip.
	beforeClose() This method is called before closing the tooltip.
	beforeOpen(aLink) This method is called before opening the tooltip.
	close() Closing function.
	closePopup(originalTarget) Method called by the popup manager.
	doClose(e, tooltip) Closing callback function called by EventHelper.addListener.
	handleEvent(evt) Handle keyboard event.
	initialize() Initialise the ClickToOpen component
	onContainerMove(dx, dy) Moving method.
	open(aLink) Open a ClickToOpen.
	setFixedZIndex(zIndex) Set a fixed z index on tooltip.

Class Detail

SweetDevRia.ClickToOpen(id, shiftX, shiftY)

Parameters:
{String} id: the id of the clickToOpen
{int} shiftX: the number of pixels to shift the tooltip on X's from the link
{int} shiftY: the number of pixels to shift the tooltip on Y's from the link

Field Detail

autoClose

Do I need to harm the timer to check if referer link has moved ?

<static> SweetDevRia.ClickToOpen.CLOSE_EVENT

This event type is fired when close the clicktoopen component

<static> SweetDevRia.ClickToOpen.OPEN_EVENT

This event type is fired when open the clicktoopen component

{int} refererPosX

Initial referer X position.

{int} refererPosY

Initial referer Y position.

{Timer} refererTimerChecker

Timer ID wich check if referer has moved.

Method Detail

afterClose()

This method is called after closing the tooltip. To be overridden !!

afterOpen(aLink)

This method is called after opening the tooltip. To be overridden !!

Parameters:
{HTMLElement} aLink: Referring link used to calculate position where open tooltip.

{boolean} beforeClose()

This method is called before closing the tooltip. To be overridden !!

Returns:: True if this method can be called, else false.

{boolean} beforeOpen(aLink)

This method is called before opening the tooltip. To be overridden !!

Parameters:
{HTMLElement} aLink: Referring link used to calculate position where open tooltip.

Returns:: True if this method can be called, else false.

close()

Closing function.

closePopup(originalTarget)

Method called by the popup manager. To override if the behaviour has to be changed.

Parameters:
originalTarget

doClose(e, tooltip)

Closing callback function called by EventHelper.addListener.

Parameters:
{Event} e: event.
{Object} tooltip: Click to open tooltip.

{boolean} handleEvent(evt)

Handle keyboard event.

Parameters:
{Event} evt: Event.

Returns:: {boolean} true if event is not active, false if component was closed.

initialize()

Initialise the ClickToOpen component

onContainerMove(dx, dy)

Moving method.

Parameters:
{int} dx: delta X to move the component to
{int} dy: delta Y to move the component to

{boolean} open(aLink)

Open a ClickToOpen.

Parameters:
{HTMLElement} aLink: Referring link used to calculate position where open tooltip.

Returns:: True if the element has been opened, false if it has been closed

setFixedZIndex(zIndex)

Set a fixed z index on tooltip.

Parameters:
{int} zIndex: Z-Index to set on tooltip.

Classes

Class SweetDevRia.ClickToOpen