Class pwlib.guiTabPanel
The tabbed panel GUI component.
Defined in: script.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| <private> |
pwlib.guiTabPanel(gui, panel)
|
| Field Attributes | Field Name and Description |
|---|---|
|
The panel container DOM element.
|
|
|
Custom application events interface.
|
|
|
Panel ID.
|
|
| <private> <inner> |
Holds the ID of the previously active tab.
|
|
Reference to the tab buttons DOM element.
|
|
|
Holds the ID of the currently active tab.
|
|
|
Holds references to the DOM element of each tab and tab button.
|
| Method Attributes | Method Name and Description |
|---|---|
| <private> <inner> |
ev_tabClick(ev)
The
click event handler for tab buttons. |
| <private> <inner> |
init()
Initialize the toolbar functionality.
|
|
tabActivate(tabId)
Activate a tab by ID.
|
|
|
tabHide(tabId)
Hide a tab by ID.
|
|
|
tabShow(tabId)
Show a tab by ID.
|
Class Detail
<private>
pwlib.guiTabPanel(gui, panel)
- Parameters:
- {pwlib.gui} gui
- Reference to the PaintWeb GUI object.
- {Element} panel
- Reference to the panel DOM element.
Field Detail
{Element}
container
The panel container DOM element.
{pwlib.appEvents}
events
Custom application events interface.
{String.}
id
Panel ID. The ID is the same as the data-pwTabPanel attribute value of the
panel DOM element .
<private> <inner>
{String}
prevTabId_
Holds the ID of the previously active tab.
{Element}
tabButtons
Reference to the tab buttons DOM element.
{String}
tabId
Holds the ID of the currently active tab.
{Object}
tabs
Holds references to the DOM element of each tab and tab button.
Method Detail
<private> <inner>
ev_tabClick(ev)
The
click event handler for tab buttons. This function simply
activates the tab the user clicked.
- Parameters:
- {Event} ev
- The DOM Event object.
<private> <inner>
init()
Initialize the toolbar functionality.
{Boolean}
tabActivate(tabId)
Activate a tab by ID.
This method dispatches the pwlib.appEvent.guiTabActivate event.
- Parameters:
- {String} tabId
- The ID of the tab you want to activate.
- Returns:
- {Boolean} True if the tab has been activated successfully, or false if not.
{Boolean}
tabHide(tabId)
Hide a tab by ID.
- Parameters:
- {String} tabId
- The ID of the tab you want to hide.
- Returns:
- {Boolean} True if the tab has been hidden successfully, or false if not.
{Boolean}
tabShow(tabId)
Show a tab by ID.
- Parameters:
- {String} tabId
- The ID of the tab you want to show.
- Returns:
- {Boolean} True if the tab has been displayed successfully, or false if not.