Designer JavaScript API Classes

As part of the Designer JavaScript API, you can use the following predefined classes.

• ibaObject. The base automation object.
• ibaAccordionContainer. Accordion container automation object.
• ibaCarouselContainer. Carousel container automation object.
• ibaContent. Content panel automation object.
• ibaPage. Page automation object. The event iba_pageloading will be triggered on the global window object. event.data will be the ibaPage object.
• ibaPanelContainer. Panel container automation object.
• ibaPortal. Portal automation object.
• ibaSection. Page section automation object.
• ibaTabContainer. Tab container automation object.

A help plug-in with information about each class is packaged with your WebFOCUS installation. It is available through a URL at the following address:

http[s]://hostname:port/context/web_resource/doc/automation/index.html

where:

hostname

Is the name of the machine on which the WebFOCUS Client is installed.

port

Is the port number on which the server is listening.

context

Is the context root of the WebFOCUS application. For example, ibi_apps.

Class: ibaObject

new ibaObject(element)

Is the base automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the node that is being automated.

Available methods include the following:

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

Class: ibaPage

new ibaPage(element)

Is the page automation object. Automation objects are created internally by the system. You never directly instantiate an automation object. The event iba_pageloading will be triggered on the global window object. event.data will be the ibaPage object.

where:

element

Is the node that is being automated.

The following triggers can be used with the page object:

• event:iba_pageloaded. The page is loaded in the running state.
• event:iba_beforecontentdescribe. Before the page content filtering information has been retrieved.
• event:iba_contentdescribed. After the page content filtering information has been retrieved, but before it has been processed.
• event:iba_beforecontentload. Before the content of a panel is about to load.

These are used in the following JavaScript syntax example:

window.addEventListener("iba_pageloading", function (e){
    var page = e.data;
    page.element().addEventListener("iba_pageloaded", function(e){
        var page = e.data;
    });
    page.element().addEventListener("iba_beforecontentdescribe", function (e){
        var describeInfo = e.data;
        var path = describeInfo.path; // The path to the content being described
        // e.preventDefault() will stop the describe from happening
    });
    page.element().addEventListener("iba_contentdescribed", function (e){
        var describeInfo = e.data;
        var path = describeInfo.path; // The path to the content being described
        var wfDescribe = describeInfo.wfDescribe; // The filtering information of the content being described
    });
    page.element().addEventListener("iba_beforecontentload", function (e){
        var loadInfo = e.data;
        var path = loadInfo.path; // The path to the content being described
        var defaultValues = loadInfo.defaultValues; // If default values are used to run the content
        // e.preventDefault() will stop the page from retrieving the content
    });
});

If you add multiple pages with custom JavaScript to the same portal, the iba_pageloading event listener, for the global window object, will execute whenever any page in the portal loads. To execute your code only when a specific page loads, remove the event listener after the code executes for the desired page using the window.removeEventListener method.

The iba_pageloading event listener can be used to access the page being loaded, since it receives a page object as a parameter. The page object can be stored or used to assign additional event handlers to the page as shown below:

function onPageLoading(e) {
    var page = e.data; 
    page.element().addEventListener("iba_pageloaded", function(e){
        on load code
    });
   page.element().addEventListener("click", function(e)
   {  
       on click code
   });
  window.removeEventListener("iba_pageloading", onPageLoading);
}

where:

function onPageLoading

Is an iba_pageloading event listener function.

var page = e.data

Accesses the page object via the event parameter.

on load code

Code to be executed when the page loads.

on click code

Code to be executed when the page is clicked.

window.removeEventListener("iba_pageloading", onPageLoading);

Removes the iba_pageloading listener.

You can use the context member object to supply the context information for the page.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the page.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addSection(options, sibling, before)

  Returns an element, adding a section to the page.

  where:

  options

  Object.

  One or more section options, which can include the following:

  • collapsible. A Boolean value. When true, the section is collapsible.
  • collapsed. A Boolean value. When true, the section is created in a collapsed state.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the section before or after the specified sibling.

• buttons(selector)

  Returns the page title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• containers(selector)

  Returns the page containers as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the containers selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• refreshFilters()

  Use to redescribe the existing content and recreate filter panels.

• removeButton(button)

  Removes one or more buttons from the title bar of the page.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeSection(selector)

  Removes one or more sections from the page.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a section selector. All is the default.

• sections(selector)

  Returns the page sections as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the section selector. All is the default.

• title(title)

  Sets the title of the page. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the page.

Class: ibaSection

The ibaSection class extends ibaObject.

new ibaSection(element)

Is the page section automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addContainer(type, title, col, row, colSpan, rowSpan)

  Adds a new container to the section.

  where:

  type

  String.

  Is one of the following container types:

  • 'pane'
  • 'tab'
  • 'accordion'
  • 'carousel'

  title

  String.

  Is the container title.

  col

  Integer.

  Optional. The column of the section to insert to. By default, the container is added to the first available column.

  row

  Integer.

  Optional. The row of the section to insert to. By default, the container is added to the first available row.

  colSpan

  Integer.

  Optional. The width of the container in columns. 3 is the default.

  rowSpan

  Integer.

  Optional. The height of the container in rows. 5 is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• collapsed(collapsed)

  Makes the section collapsed, or returns the current collapsed state or a chainable automation object.

  where:

  collapsed

  Boolean.

  Optional. If true, collapse the section. Otherwise, expand.

• collapsible(collapsible)

  Makes the section collapsible, or returns the current collapsible state or a chainable automation object.

  where:

  collapsible

  Boolean.

  Optional. If true, make the section collapsible.

• containers(selector)

  Returns the containers in the section as an array.

  where:

  selector

  Selector, element, or jQuery.

  An optional containers selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

Class: ibaContainer

new ibaContainer(element)

Is the container automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the container.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addContent(path, description, replaceExisting)

  Returns elements. Adds new content by replacing the content in the current content panel or adding a sub-panel.

  where:

  path

  String.

  Path of the content being added.

  description

  String.

  Description of the content being added.

  replaceExisting

  Boolean.

  Optional. When true, replace the existing content. When false, which is the default, add new content.

• addMenuItem(options, sibling, before)

  Returns an element, adding a menu item to the container menu.

  where:

  options

  Object.

  One or more menu item options, which can include the following:

  • text. The menu item text.
  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the menu item before or after the specified sibling.

• addMenuSeparator(options, sibling, before)

  Returns an element, adding a separator to the container menu.

  where:

  options

  Object.

  Menu separator options. You can use the class property to specify additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add menu separator before or after the specified sibling.

• buttons(selector)

  Returns the container title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• contents(selector)

  Returns the content panels in the container as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the content selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• removeButton(button)

  Removes one or more buttons from the title bar of the container.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeContent(selector)

  Removes content from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• removeMenuItem(selector)

  Removes one or more menu items from the container menu.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu item selector. All is the default.

• removeMenuSeparator(selector)

  Removes one or more separators from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu separator selector. All is the default.

• title(title)

  Sets the title of the container. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the container.

Class: ibaAccordionContainer

The ibaAccordionContainer class extends ibaContainer.

new ibaAccordionContainer(element)

Is the accordion container automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the accordion container.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addContent(path, description, replaceExisting)

  Returns elements. Adds new content by replacing the content in the current content panel or adding a new accordion tab.

  where:

  path

  String.

  Path of the content being added.

  description

  String.

  Description of the content being added.

  replaceExisting

  Boolean.

  Optional. When true, replace the existing content. When false, which is the default, add new content.

• addMenuItem(options, sibling, before)

  Returns an element, adding a menu item to the accordion container menu.

  where:

  options

  Object.

  One or more menu item options, which can include the following:

  • text. The menu item text.
  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the menu item before or after the specified sibling.

• addMenuSeparator(options, sibling, before)

  Returns an element, adding a separator to the accordion container menu.

  where:

  options

  Object.

  Menu separator options. You can use the class property to specify additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add menu separator before or after the specified sibling.

• buttons(selector)

  Returns the container title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• contents(selector)

  Returns the content panels in the container as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the content selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• removeButton(button)

  Removes one or more buttons from the title bar of the container.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeContent(selector)

  Removes content from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• removeMenuItem(selector)

  Removes one or more menu items from the container menu.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu item selector. All is the default.

• removeMenuSeparator(selector)

  Removes one or more separators from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu separator selector. All is the default.

• selectContent(selector)

  Returns an element. Selects a content pane in the accordion container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• title(title)

  Sets the title of the container. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the container.

Class: ibaCarouselContainer

The ibaCarouselContainer class extends ibaContainer.

new ibaCarouselContainer(element)

Is the carousel container automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the carousel container.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addContent(path, description, replaceExisting)

  Returns elements. Adds new content by replacing the content in the current content panel or adding a new carousel slide.

  where:

  path

  String.

  Path of the content being added.

  description

  String.

  Description of the content being added.

  replaceExisting

  Boolean.

  Optional. When true, replace the existing content. When false, which is the default, add new content.

• addMenuItem(options, sibling, before)

  Returns an element, adding a menu item to the carousel container menu.

  where:

  options

  Object.

  One or more menu item options, which can include the following:

  • text. The menu item text.
  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the menu item before or after the specified sibling.

• addMenuSeparator(options, sibling, before)

  Returns an element, adding a separator to the carousel container menu.

  where:

  options

  Object.

  Menu separator options. You can use the class property to specify additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add menu separator before or after the specified sibling.

• buttons(selector)

  Returns the container title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• contents(selector)

  Returns the content panels in the container as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the content selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• removeButton(button)

  Removes one or more buttons from the title bar of the container.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeContent(selector)

  Removes content from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• removeMenuItem(selector)

  Removes one or more menu items from the container menu.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu item selector. All is the default.

• removeMenuSeparator(selector)

  Removes one or more separators from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu separator selector. All is the default.

• selectContent(selector)

  Returns an element. Selects a content pane in the carousel container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• title(title)

  Sets the title of the container. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the container.

Class: ibaPanelContainer

The ibaPanelContainer class extends ibaContainer.

new ibaPanelContainer(element)

Is the panel container automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the panel container.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addContent(path, description, replaceExisting)

  Returns elements. Adds new content by replacing the content in the current content panel or adding a new panel.

  where:

  path

  String.

  Path of the content being added.

  description

  String.

  Description of the content being added.

  replaceExisting

  Boolean.

  Optional. When true, replace the existing content. When false, which is the default, add new content.

• addMenuItem(options, sibling, before)

  Returns an element, adding a menu item to the container menu.

  where:

  options

  Object.

  One or more menu item options, which can include the following:

  • text. The menu item text.
  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the menu item before or after the specified sibling.

• addMenuSeparator(options, sibling, before)

  Returns an element, adding a separator to the container menu.

  where:

  options

  Object.

  Menu separator options. You can use the class property to specify additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add menu separator before or after the specified sibling.

• buttons(selector)

  Returns the container title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• contents(selector)

  Returns the content panels in the container as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the content selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• removeButton(button)

  Removes one or more buttons from the title bar of the container.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeContent(selector)

  Removes content from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• removeMenuItem(selector)

  Removes one or more menu items from the container menu.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu item selector. All is the default.

• removeMenuSeparator(selector)

  Removes one or more separators from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu separator selector. All is the default.

• title(title)

  Sets the title of the container. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the container.

Class: ibaTabContainer

The ibaTabContainer class extends ibaContainer.

new ibaTabContainer(element)

Is the carousel container automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• addButton(options, sibling, before)

  Returns an element, adding a button to the title bar of the tab container.

  where:

  options

  Object.

  One or more button options, which can include the following:

  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.
  • tooltip. A tooltip for the button.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add button before or after the specified sibling.

• addContent(path, description, replaceExisting)

  Returns elements. Adds new content by replacing the content in the current content panel or adding a new tab.

  where:

  path

  String.

  Path of the content being added.

  description

  String.

  Description of the content being added.

  replaceExisting

  Boolean.

  Optional. When true, replace the existing content. When false, which is the default, add new content.

• addMenuItem(options, sibling, before)

  Returns an element, adding a menu item to the tab container menu.

  where:

  options

  Object.

  One or more menu item options, which can include the following:

  • text. The menu item text.
  • icon. A URL to an image file in .jpeg, .png, or .gif format.
  • glyph. A glyph or ligature, such as a Material icon.
  • glyphClasses. Glyph classes. For example, 'material-icons'.
  • class. Additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add the menu item before or after the specified sibling.

• addMenuSeparator(options, sibling, before)

  Returns an element, adding a separator to the tab container menu.

  where:

  options

  Object.

  Menu separator options. You can use the class property to specify additional CSS classes.

  sibling

  Selector, element, or jQuery.

  Optional. A sibling to add before or after. The default is Last.

  before

  Boolean.

  Add menu separator before or after the specified sibling.

• buttons(selector)

  Returns the container title bar buttons as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the buttons selector. All is the default.

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• contents(selector)

  Returns the content panels in the container as an array.

  where:

  selector

  Selector, element, or jQuery.

  Is the content selector. All is the default.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, the DOM node that is being automated by this object.

• removeButton(button)

  Removes one or more buttons from the title bar of the container.

  where:

  button

  Selector, element, or jQuery.

  Optional. Is a button selector. All is the default.

• removeContent(selector)

  Removes content from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• removeMenuItem(selector)

  Removes one or more menu items from the container menu.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu item selector. All is the default.

• removeMenuSeparator(selector)

  Removes one or more separators from the container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a menu separator selector. All is the default.

• selectContent(selector)

  Returns an element. Selects a content pane in the tab container.

  where:

  selector

  Selector, element, or jQuery.

  Optional. Is a content selector. All is the default.

• title(title)

  Sets the title of the container. If title is not passed, the title of the container is returned as a string or jQuery.

  where:

  title

  String.

  Optional. Is the new title of the container.

Class: ibaContent

The ibaContent class extends ibaObject.

new ibaContent(element)

Is the content panel automation object. Automation objects are created internally by the system. You never directly instantiate an automation object.

where:

element

Is the DOM node that is being automated.

Available methods include the following:

• classId()

  Returns a string, which is the unique, automatically generated class ID of the object being automated. It can be used to filter enumerations.

• customClasses(classes, remove)

  Returns a string. Sets or gets custom classes.

  where:

  classes

  String.

  Optional. A space-separated list of classes to be added or removed.

  remove

  Boolean.

  Optional. If true, remove the classes specified in classes, otherwise add them.

• element()

  Returns an element, which is the DOM node that is being automated by this object.

• path()

  Returns the path of the content as a string.