Class CAF.Popup

Object
   |
   +--CAF.Popup

class CAF.Popup

Defined in popup.js

Field Detail

mouseoutDelay

<static> Object mouseoutDelay

Time in ms to delay closing the currently open popup when the mouse exits the popup or hotspot (and is not over another popup or hotspot).

mouseoverHotspotDelay

<static> Object mouseoverHotspotDelay

Time in ms to delay showing popup when mouse hovers over hotspot (and no other popup is current open).

mouseoverOtherHotspotDelay

<static> Object mouseoverOtherHotspotDelay

Time in ms to delay closing the currently open popup when the mouse hovers over an unrelated popup's hotspot.

mouseoverPopupDelay

<static> Object mouseoverPopupDelay

Time in ms to delay closing the currently open popup when the mouse hovers over an unrelated popup.

CAF.Popup

CAF.Popup()

addClick

<static> void addClick(hotspot, popup, rightclick)

Adds hotspot to trigger popup on click. A hotspot can be used for only one popup at a time (although the same hotspot can be used for click and hover purposes simultaneously).

Parameters:
hotspot - Hotspot element or id.
popup - Popup element or id.

addHover

<static> void addHover(hotspot, popup)

Adds hotspot to trigger popup on hover. A hotspot can be used for only one popup at a time (although the same hotspot can be used for click and hover purposes simultaneously).

Parameters:
hotspot - Hotspot element or id.
popup - Popup element or id.

addItem

<static> Object addItem(id, item, before)

Adds a new item to the specified menu.

Parameters:
id - Element id of menu.
item - Object with menu item properties. Properties may include:

value

Item link (ie "CAF.Popup.javascript = doSomething();" or "http://google.com").

label

Item label.

rawhtml

True if label is raw html (and should not be escaped), false otherwise (the default).

icon

Item icon source url (ie "/myapp/images/myicon.gif").

disabled

True if item is disabled.

selected

True if item is selected (ie item is displayed as 'checked').

style

Item css style (ie "CAF.Popup.color = blue;;").

styleClass

Item css class (ie "open"). The first css class specified is also used as the item's id (note that multiple css classes can be specified by separating class names with whitespace (ie "open portlet-menu-item").

separator

True if item is just a separator (defaults to false). If the item's label or value consists of dashes ('-'), the item will also be displayed as a separator.

submenu

Id of menu to display as item submenu.

before - (optional) Element or class-name of item before which to insert the new item.

Returns:
New item element.

addRightClick

<static> void addRightClick(hotspot, popup)

Adds hotspot to trigger popup on rightclick. A hotspot can be used for only one popup at a time (although the same hotspot can be used for click and hover purposes simultaneously).

Parameters:
hotspot - Hotspot element or id.
popup - Popup element or id.

attachContextMenu

<static> void attachContextMenu( element, popup )

attachPopup

<static> void attachPopup(element, popup, hover, click, rightclick)

Attaches the specified popup to the specified element.

Parameters:
element - Element or id of element for which to show the popup.
popup - Element or id of popup.
hover - (optional) True to popup when mouse hovers over element (defaults to false).
click - (optional) True to popup when mouse clicks element (defaults to true).
rightclick - (optional) True to popup when mouse right-clicks element (defaults to false).

create

<static> Object create(id, items, css)

Creates a new menu with the specified id and items.

Parameters:
id - Element id of menu to create.
items - (optional) List of items to add to new menu.
css - (optional) CSS classe name for new menu.

Returns:
New menu element.

detachPopup

<static> void detachPopup(element)

Removes a tooltip created by CAF.Popup#attachHover for the specified element.

Parameters:
element - Element or id of element for which to detach tooltip.name

get

<static> Object get(id)

Returns the specified menu or null.

Parameters:
id - Element id of menu.

Returns:
Menu element or null.

getItem

<static> Object getItem(id, itemClass)

Returns the specified item for the specified menu.

Parameters:
id - Element id of menu.
Class - name of menu item.

Returns:
Menu item element or null.

hideAll

<static> void hideAll()

Hides all open menus and tooltips.

listItems

<static> Object listItems(id)

Returns the list of items for the specified menu.

Parameters:
id - Element id of menu.

Returns:
Array of items elements or empty array.

removeClick

<static> void removeClick(hotspot, rightclick)

Remove hotspot from triggering popup on click.

Parameters:
hotspot - Hotspot element or id.

removeHover

<static> void removeHover(hotspot)

Adds hotspot from triggering popup on hover.

Parameters:
hotspot - Hotspot element or id.

removeItem

<static> Object removeItem(id, itemClass)

Removes the specified menu item.

Parameters:
id - Element id of menu.
itemClass - Class name of menu item.

Returns:
Removed element or null (if item not found).

removeRightClick

<static> void removeRightClick(hotspot)

Remove hotspot from triggering popup on rightclick.

Parameters:
hotspot - Hotspot element or id.

setDisabled

<static> void setDisabled(id, itemClass, disable)

Enables/disables the specified menu item.

Parameters:
id - Element id of menu.
itemClass - Class name of menu item.
disable - True to disable, false to enable.

setItem

<static> Object setItem(id, item)

Replaces the specified menu item.

Parameters:
id - Element id of menu.
Object - with menu item properties (see addItem() for details).

Returns:
New menu item element or null (if existing item not found).

setLabel

<static> void setLabel(id, itemClass, label, rawhtml)

Updates the label of the specified menu item.

Parameters:
id - Element id of menu.
itemClass - Class name of menu item.
label - New label.
rawhtml - (optional) True if label is raw html (and should not be escaped), false otherwise (the default).

setSelected

<static> void setSelected(id, itemClass, select)

Selects/deselects the specified menu item (a selected item might be displayed as 'checked').

Parameters:
id - Element id of menu.
itemClass - Class name of menu item.
select - True to select, false to deselect.

setValue

<static> void setValue(id, itemClass, value)

Updates the value (link href) of the specified menu item.

Parameters:
id - Element id of menu.
itemClass - Class name of menu item.
value - New value.