Package docking.help

Class GHelpHTMLEditorKit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, javax.accessibility.Accessible
    public class GHelpHTMLEditorKit
extends javax.swing.text.html.HTMLEditorKit
    A class that allows Ghidra to intercept JavaHelp navigation events in order to resolve them to Ghidra's help system. Without this class, contribution plugins have no way of referencing help documents within Ghidra's default help location.

    This class is currently installed by the GHelpSet.

    See Also:
    GHelpSet, Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.text.html.HTMLEditorKit

        javax.swing.text.html.HTMLEditorKit.HTMLFactory, javax.swing.text.html.HTMLEditorKit.HTMLTextAction, javax.swing.text.html.HTMLEditorKit.InsertHTMLTextAction, javax.swing.text.html.HTMLEditorKit.LinkController, javax.swing.text.html.HTMLEditorKit.Parser, javax.swing.text.html.HTMLEditorKit.ParserCallback

      • Nested classes/interfaces inherited from class javax.swing.text.StyledEditorKit

        javax.swing.text.StyledEditorKit.AlignmentAction, javax.swing.text.StyledEditorKit.BoldAction, javax.swing.text.StyledEditorKit.FontFamilyAction, javax.swing.text.StyledEditorKit.FontSizeAction, javax.swing.text.StyledEditorKit.ForegroundAction, javax.swing.text.StyledEditorKit.ItalicAction, javax.swing.text.StyledEditorKit.StyledTextAction, javax.swing.text.StyledEditorKit.UnderlineAction

      • Nested classes/interfaces inherited from class javax.swing.text.DefaultEditorKit

        javax.swing.text.DefaultEditorKit.BeepAction, javax.swing.text.DefaultEditorKit.CopyAction, javax.swing.text.DefaultEditorKit.CutAction, javax.swing.text.DefaultEditorKit.DefaultKeyTypedAction, javax.swing.text.DefaultEditorKit.InsertBreakAction, javax.swing.text.DefaultEditorKit.InsertContentAction, javax.swing.text.DefaultEditorKit.InsertTabAction, javax.swing.text.DefaultEditorKit.PasteAction

    • Field Summary

      • Fields inherited from class javax.swing.text.html.HTMLEditorKit

        BOLD_ACTION, COLOR_ACTION, DEFAULT_CSS, FONT_CHANGE_BIGGER, FONT_CHANGE_SMALLER, IMG_ALIGN_BOTTOM, IMG_ALIGN_MIDDLE, IMG_ALIGN_TOP, IMG_BORDER, ITALIC_ACTION, LOGICAL_STYLE_ACTION, PARA_INDENT_LEFT, PARA_INDENT_RIGHT

      • Fields inherited from class javax.swing.text.DefaultEditorKit

        backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, downAction, endAction, endLineAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deinstall​(javax.swing.JEditorPane c)  
      javax.swing.text.ViewFactory getViewFactory()  
      void install​(javax.swing.JEditorPane c)  
      void read​(java.io.Reader in, javax.swing.text.Document doc, int pos)  
      static void zoomIn()  
      static void zoomOut()  

      • Methods inherited from class javax.swing.text.html.HTMLEditorKit

        clone, createDefaultDocument, createInputAttributes, getAccessibleContext, getActions, getContentType, getDefaultCursor, getInputAttributes, getLinkCursor, getParser, getStyleSheet, insertHTML, isAutoFormSubmission, setAutoFormSubmission, setDefaultCursor, setLinkCursor, setStyleSheet, write

      • Methods inherited from class javax.swing.text.StyledEditorKit

        getCharacterAttributeRun

      • Methods inherited from class javax.swing.text.DefaultEditorKit

        createCaret, read, write

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GHelpHTMLEditorKit

        public GHelpHTMLEditorKit()

    • Method Detail

      • getViewFactory

        public javax.swing.text.ViewFactory getViewFactory()
        Overrides:
        getViewFactory in class javax.swing.text.html.HTMLEditorKit

      • install

        public void install​(javax.swing.JEditorPane c)
        Overrides:
        install in class javax.swing.text.html.HTMLEditorKit

      • deinstall

        public void deinstall​(javax.swing.JEditorPane c)
        Overrides:
        deinstall in class javax.swing.text.html.HTMLEditorKit

      • read

        public void read​(java.io.Reader in,
                 javax.swing.text.Document doc,
                 int pos)
          throws java.io.IOException,
                 javax.swing.text.BadLocationException
        Overrides:
        read in class javax.swing.text.html.HTMLEditorKit
        Throws:
        java.io.IOException
        javax.swing.text.BadLocationException

      • zoomOut

        public static void zoomOut()

      • zoomIn

        public static void zoomIn()