Markup Interface

The structure browser can display, edit, and save a markup. The structure browser provides the hooks for these tasks; you must define the custom page that implements the markup.

The JavaScript API allows the structure browser to:


  • Display 1 or more markups for a specific object, including visual cues
  • Send markup data for a single level from a selected object
  • Save the markup

When saving a markup, a single markup is created for each parent object that had changes. Saving a markup saves all changes for all objects in the structure browser regardless of row selection.

See Editing a Structured Data Page for a description of the visual cues.

The JavaScript sends and loads XML string data; the custom application must handle saving the markup in the database.

Once loaded (the custom application passes the XML string data to the structure browser), users can work with the data as in any other structure browser, including any editing functions configured for the page. If the showApply=true URL parameter was passed to the structure browser, the edit mode includes an Apply button. If the user clicks this button, the edits, including any loaded markups, are saved to the database. To prevent the user from saving marked-up changes to the database, pass the showApply=false URL parameter. The custom application must then provide a means, such as saving the markup, to retain the edits made by the user.

The API includes these JavaScript methods to work with markups:


  • editableTable.getMarkupXML()--Returns an XML string to the custom page.
  • editableTable.loadMarkupXML(URL - JSP with parameters)--Applies a markup to an already loaded structure browser page.

Refer to the API documentation for details about the JavaScript methods to perform this functionality.