JavaScript Functions › Action Tab Functions

Action Tab Functions

The following functions assist in building the action tabs on a page and the pop-up action menu as well:

• addAction

  The addAction function adds an action object to the actions array for future display as an action tab or as an action within the pop-up action menu.

  • Syntax

    addAction(actionId, label, url, tooltip)
    

  • Parameters
    • actionId—The action ID mnemonic that identifies this action
    • label—The text label displayed for this action
    • url—The web page to request when the user selects this action
    • tooltip—Text that appears when you move the mouse over the button
  • Example

    addAction(tables,Table examples, tables.esp,Show how to create a table);
    

• addActionSeparator

  The addActionSeparator functions adds a separator line to the list of actions in the pop-up menu.

  • Syntax

    addActionSeparator()
    

  • Parameters

    None.

  • Example

    addActionSeparator()
    

• setAction

  The setAction function sets the status of an action to active (that is, the currently selected action).

  • Syntax

    setAction(actionId)
    

  • Parameters
    • actionId—The action ID mnemonic that identifies the action
  • Example

    setAction(tables);
    

• setActionDisabled

  The setActionDisabled function sets the status of an action to disabled (that is, not selectable).

  • Syntax

    setActionDisabled(actionId)
    

  • Parameters
    • actionId—The action ID mnemonic that identifies the action
  • Example

    setActionDisabled(tables);
    

• setActionPath

  The setActionPath function sets the file path prefix for all subsequent addAction( ) calls to the file path provided.

  • Syntax

    setActionPath(path)
    

  • Parameters
    • path—The slash-terminated file path prefix
  • Example

    setActionPath(/user/operator/);
    

• showActionBar

  The showActionBar function renders the action tabs within the Select section of a web page. It is passed to the action ID of the action to be rendered as active and passes this action ID on a call to setAction( ).

  • Syntax

    showActionBar(actionId)
    

  • Parameters
    • actionId—The action ID mnemonic that identifies the active action
  • Example

    showActionBar(tables);