Package com.orchestranetworks.ui.form

# Interface UIFormHeader

public interface UIFormHeader
Allows defining the header of a custom form.

Since:
  5.3.0
See Also:
  - `UIForm.defineHeader(UIFormHeader, UIFormContext)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `removePagingPane()`
  Removes the paging pane.
  `void`
  `removeServicesMenu()`
  Removes the menu for services.
  `void`
  `setContextSensitiveHelpURL(String aURL)`
  Overrides the default URL of the context-sensitive help button.
  `void`
  `setTitle(UIFormLabelSpec aTitle)`
  Defines a custom title in the header of the form.
  `void`
  `setToolbar(Toolbar aToolbar)`
  Defines a toolbar that will be displayed on top of the form.

- ## Method Details

  - ### removePagingPane

    void removePagingPane()
    Removes the paging pane.

    The paging pane allows navigating to the next or previous object in the container view.

  - ### removeServicesMenu

    void removeServicesMenu()
    Removes the menu for services. Does nothing if a toolbar is defined (`setToolbar(Toolbar)`).

  - ### setToolbar

    void setToolbar(Toolbar aToolbar)
    Defines a toolbar that will be displayed on top of the form.
    Since:
      5.7.1
    See Also:
      - `Toolbar`

  - ### setContextSensitiveHelpURL

    void setContextSensitiveHelpURL(String aURL)
    Overrides the default URL of the context-sensitive help button.

    Clicking on the button displays the help pop-up with the target URL.

    A simple help button can also be placed anywhere using `UIComponentWriter.addButtonHelp(String)`.

    Parameters:
      `aURL` - the URL of the pop-up content.

  - ### setTitle

    void setTitle(UIFormLabelSpec aTitle)
    Defines a custom title in the header of the form.
    Parameters:
      `aTitle` - the label with an optional documentation pane to set as header title.