Custom Components Reference for (deprecated) Guides

When you create a Flex library project for a Guide extension, include the Guide runtime SWC file. Including the SWC file adds a collection of Guide extensions in a Guide folder in the Flash Builder Components view. The Guide extensions include everything necessary to create custom Guide layouts and panel layouts.

The custom components that you can add to layouts are listed alphabetically in the Flash Builder Components view. They fall into the following categories:

  • Button components

  • Help components

  • Label components

  • Navigation components

  • Output components

    Button components

    Button components provide the most common Guide actions.

    AddPanelButton

    Adds a new panel to a list of repeating panels. This button is available only when the following statements are true:

    • The current panel can repeat.

    • Adding a new panel does not conflict with the maximum occurrence value of the associated object on the form.

    CopyPanelButton

    Creates a copy of the currently selected panel and adds it to the list of repeating panels. This button is available only when the following statements are true:

    • The current panel can repeat.

    • Adding a copy of the current panel does not conflict with the maximum occurrence value of the associated object on the form.

    NextPanelButton

    Displays the next panel in the Guide tree. If the current panel is the last panel in the tree, the button is not available.

    PreviousPanelButton

    Displays the previous panel in the Guide tree. If the current panel is the first panel in the tree, the button is not available.

    RemovePanelButton

    Removes the current panel from the list of repeating panels. This button is available only when the following statements are true:

    • The current panel can repeat.

    • Removing the current panel does not conflict with the minimum occurrence value of the associated object on the form.

    SubmitButton

    Displays a submit button, but only when the current panel is the last panel in the Guide tree. When the Guide filler clicks the button, it performs an action. The action depends on the values that you selected in the Submit From list in Workbench:

    Guide
    (Default) Data submission depends on where the Guide is running. If the Guide runs in a browser, the submit button appears in the navigation button area, where the Next and Previous buttons appear. Typically it appears on the last visible panel in the Guide. When the Guide runs in Workspace, no submit button appears on the Guide, and the data is submitted from a button on the Workspace chrome.

    Interactive PDF
    Submits the data from an interactive PDF document. This option is available when the Guide is based on an XDP form, and includes an interactive PDF form. When you select this option, a Submit From PDF button appears in the navigation button area. Clicking this button switches the view to the interactive PDF document, which must include a Submit button. The Submit From PDF button appears in all environments where the Guide runs, such as Workspace or a browser. No other submit button appears in the navigation button area of the Guide or in the Workspace chrome.

    User Button
    Submits the data from a button that you add to a panel in the Guide. This submit button appears in all environments where the Guide can run. No other submit button appears in the navigation button area of the Guide or in the Workspace chrome.
    Note: In Guides based on XDP or PDF forms, Email Submit Buttons are not supported.

    Host
    Specifies that data is submitted from the application that is hosting the Guide, such as Workspace. The submit button appears on the Workspace chrome, under the Guide. There is no submit button in the navigation button area of the Guide.

      Help components

      Help components let you display help to end users in text, image, and video format:

      HelpBox
      Displays Guide help.

      HelpCenter
      Displays a centralized region within a Guide layout to display Guide help and panel help.

      HelpPanel
      Displays panel help.

      HelpVideo
      Displays the help video control.

        Label components

        Label components provide objects that display section and panel titles:

        PanelTitle
        A label that displays the name of the currently selected panel.

        SectionTitle
        A label that displays the name of the currently selected section.

          Navigation components

          Navigation components provide the system for navigating the sections and panels of a Guide:

          AccordionNav
          An accordion menu where each section contains a list of panels. For example, the default Guide layout named Left Accordion is an AccordionNav component.

          MxTreeNav
          A tree structure that lists multiple section and panel levels. For example, the default Guide layout named Cobalt Tree is an MxTreeNav component.
          Note: The MxTreeNav component is the only navigation component that displays nested section and panel levels.

          ProgressSectionBarNav
          A horizontal list of buttons that represents each section in the Guide tree. For example, the default Guide layout named Cobalt Bar is a ProgressSectionBarNav component.
          Note: This navigator is useful when each Guide section includes only one panel.

          StepNav
          An accordion menu where each section contains a list of panels. For example, the default Guide layout named Cobalt Standard is a StepNav component.

          TabTabNav
          A navigation system that has two corresponding levels of tab menus. The top-level tabs list the sections in the Guide tree, and the bottom-level tabs list the panels for the selected top-level tab. For example, the default Guide layout named Workspace is a TabTabNav component.

            Output components

            Output components provide objects that display content or functionality to users at runtime.

            PanelContent
            Displays the content of Guide panels.

            ProgressBar
            Indicates the percentage of required fields that a Guide filler entered data into. This control is not available if the Guide does not contain required fields.

            ToolBar
            Displays the Guide toolbar, which includes the Save PDF, Print PDF, Email PDF, and Show/Hide PDF controls. For information about including a PDF file with a Guide, see Include documents with a Guide.

              // Ethnio survey code removed