new PopupPanel(id, options)
Backing object for rich:popupPanel
Parameters:
| Name | Type | Description |
|---|---|---|
id |
||
options |
- Source:
Extends
Members
name :string
Component name.
Type:
- string
- Inherited From:
- Source:
Methods
attachToDom(source) → {DOMElement}
Attach component object to DOM element by component id, DOM element or jQuery object and returns the element
Its required for the client side API calls and to clean up after ajax request or document unload by
calling destroy method
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | DOMElement | jQuery | component id, DOM element or DOM elements wrapped by jQuery |
- Inherited From:
- Source:
Returns:
- Type
- DOMElement
destroy()
Destroy method. Will be called before remove component from the page
- Inherited From:
- Source:
detach(source)
Detach component object from DOM element by component id, DOM element or jQuery object
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | DOMElement | jQuery | component id, DOM element or DOM elements wrapped by jQuery |
- Inherited From:
- Source:
getEventElement() → {string}
Method returns element's id for event handlers binding.
Event API calls this method when binding by component object as selector was used.
- Inherited From:
- Source:
Returns:
- Type
- string
getLeft() → {string}
Returns the left coordinate of the popup
- Source:
Returns:
left coordinate
- Type
- string
getTop() → {string}
Returns the top coordinate of the popup
- Source:
Returns:
top coordinate
- Type
- string
hide()
Hide the popup panel
- Source:
invokeEvent(eventType, element, event, data) → {boolean}
Invokes event on on the DOM element
Parameters:
| Name | Type | Description |
|---|---|---|
eventType |
string | event type, e.g. "click" |
element |
DOMElement | DOM element object |
event |
Event | jQuery Event |
data |
Object | additional data used for event handler |
- Inherited From:
- Source:
Returns:
true if an event is successfully invoked
- Type
- boolean
moveTo(top, left)
Move the popup panel
Parameters:
| Name | Type | Description |
|---|---|---|
top |
number | string | top coordinate |
left |
number | string | left coordinate |
- Source:
resize(dx, dy)
Resize the popup panel
Parameters:
| Name | Type | Description |
|---|---|---|
dx |
number | value to be added to current width |
dy |
number | value to be added to current height |
- Source:
show(eventopt, optsopt)
Show the popup panel
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
Event |
<optional> |
event triggering this behavior |
opts |
Object |
<optional> |
object containing options for the popup (top, left, width, height) |
- Source:
toString() → {string}
Method for converting object to string
- Inherited From:
- Source:
Returns:
- Type
- string