Package edu.cnu.mdi.view

Class JsonViewInfo

java.lang.Object
edu.cnu.mdi.view.AbstractViewInfo
edu.cnu.mdi.view.JsonViewInfo
public class JsonViewInfo extends AbstractViewInfo
Describes the JsonView for the in-app help / info dialog.

Returned by JsonView.getViewInfo() and displayed when the user clicks the info button in the view's title bar.

  • Constructor Details

    • JsonViewInfo

      public JsonViewInfo()

  • Method Details

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in class AbstractViewInfo
      Returns:
      "JSON Viewer"

    • getPurpose

      public String getPurpose()
      Specified by:
      getPurpose in class AbstractViewInfo
      Returns:
      a short description of the viewer's purpose

    • getUsageSteps

      public List<String> getUsageSteps()
      Usage steps (optional alternative to bullets). Each step should be plain text (not HTML). The framework will escape it.

      Returns the steps a user takes to open and work with a file.

      Overrides:
      getUsageSteps in class AbstractViewInfo
      Returns:
      List of usage steps, or empty list if none.

    • getUsageBullets

      public List<String> getUsageBullets()
      Usage bullets (preferred). Each bullet should be plain text (not HTML). The framework will escape it.

      Returns additional notes about the viewer's behaviour.

      Overrides:
      getUsageBullets in class AbstractViewInfo
      Returns:
      List of usage bullets, or empty list if none.

    • getKeyboardShortcuts

      public Map<String,String> getKeyboardShortcuts()
      A map of Key Combo -> Action (e.g., "Ctrl+S" -> "Save"). Keys and actions are treated as plain text.

      Returns keyboard shortcuts in display order. A LinkedHashMap is used so insertion order is preserved in the rendered dialog.

      Overrides:
      getKeyboardShortcuts in class AbstractViewInfo
      Returns:
      Map of keyboard shortcuts, or empty map if none.

    • getTechnicalNotes

      public String getTechnicalNotes()

      Returns implementation notes useful to developers extending or integrating the viewer.

      Overrides:
      getTechnicalNotes in class AbstractViewInfo
      Returns:
      Technical notes. Plain text.

    • getAccentColorHex

      protected String getAccentColorHex()
      Accent color used for section headers. Keep simple; Swing HTML is limited.

      Uses a blue accent to echo the key color used in the raw pane (JsonRawPane.COLOR_KEY, cornflower blue).

      Overrides:
      getAccentColorHex in class AbstractViewInfo

    • getFooter

      public String getFooter()
      Overrides:
      getFooter in class AbstractViewInfo
      Returns:
      "JSON Viewer — MDI Framework"