workbench.main.javahelp

Class PDFInterceptor

java.lang.Object

javax.swing.text.EditorKit

javax.swing.text.DefaultEditorKit

javax.swing.text.StyledEditorKit

javax.swing.text.html.HTMLEditorKit

com.sun.java.help.impl.CustomKit

workbench.main.javahelp.PDFInterceptor

All Implemented Interfaces:

Serializable, Cloneable, EventListener, Accessible, HyperlinkListener

public class PDFInterceptor
extends com.sun.java.help.impl.CustomKit
implements HyperlinkListener

Autonomous Underwater Vehicle Workbench Naval Postgraduate School, Monterey, CA www.nps.edu By: Mike Bailey Date: Mar 21, 2005 Time: 1:03:09 PM

Version:

$Id: PDFInterceptor.java 9109 2015-07-29 22:39:46Z brutzman $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.java.help.impl.CustomKit

com.sun.java.help.impl.CustomKit.MouseHandler

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

HTMLEditorKit.HTMLFactory, HTMLEditorKit.HTMLTextAction, HTMLEditorKit.InsertHTMLTextAction, HTMLEditorKit.LinkController, HTMLEditorKit.Parser, HTMLEditorKit.ParserCallback

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

StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.StyledTextAction, StyledEditorKit.UnderlineAction

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

DefaultEditorKit.BeepAction, DefaultEditorKit.CopyAction, DefaultEditorKit.CutAction, DefaultEditorKit.DefaultKeyTypedAction, DefaultEditorKit.InsertBreakAction, DefaultEditorKit.InsertContentAction, DefaultEditorKit.InsertTabAction, DefaultEditorKit.PasteAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	JHEXTERN_PROTOCOL
static String	MAILTO_PROTOCOL
protected URLStreamHandler	myexternalHandler This class is used for forcing some URLs to be rendered externally.

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

Constructor Summary

Constructors

Constructor and Description
PDFInterceptor() This class gets instantiated with a zero-arg constructor.

Method Summary

Modifier and Type	Method and Description
static void	addLinkHandler(HyperlinkListener lis)
Object	clone()
static URLStreamHandlerFactory	getProtocolTrap()
void	hyperlinkUpdate(HyperlinkEvent e) This receives events from the javahelp jeditorpane for mouse in, mouse out and mouse click of a hyper link.
void	install(JEditorPane jEditorPane) Need to get hold of the JEditorPane used to render HTML, so we can trap links to pdfs, or whatever
static void	setSuffix(String suffix)

Methods inherited from class com.sun.java.help.impl.CustomKit

createDefaultDocument, deinstall, getViewFactory

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

createInputAttributes, getAccessibleContext, getActions, getContentType, getDefaultCursor, getInputAttributes, getLinkCursor, getParser, getStyleSheet, insertHTML, isAutoFormSubmission, read, 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

Field Detail

JHEXTERN_PROTOCOL

public static final String JHEXTERN_PROTOCOL

See Also:

Constant Field Values

MAILTO_PROTOCOL

public static final String MAILTO_PROTOCOL

See Also:

Constant Field Values

myexternalHandler

protected URLStreamHandler myexternalHandler

This class is used for forcing some URLs to be rendered externally. Instead of trapping file types, this uses the java.net scheme for adding new protocol handlers. Any link in one of our help pages that starts with "jhextern:" will be handled here. We throw up a few lines telling that the page is externally rendered. The event handler above still gets the event, and fires off the browser.

Constructor Detail

PDFInterceptor

public PDFInterceptor()

This class gets instantiated with a zero-arg constructor.

Method Detail

setSuffix

public static void setSuffix(String suffix)

Parameters:

suffix -

addLinkHandler

public static void addLinkHandler(HyperlinkListener lis)

Parameters:

lis -

clone

public Object clone()

Overrides:

clone in class com.sun.java.help.impl.CustomKit

install

public void install(JEditorPane jEditorPane)

Need to get hold of the JEditorPane used to render HTML, so we can trap links to pdfs, or whatever

Overrides:

install in class com.sun.java.help.impl.CustomKit

Parameters:

jEditorPane -

hyperlinkUpdate

public void hyperlinkUpdate(HyperlinkEvent e)

This receives events from the javahelp jeditorpane for mouse in, mouse out and mouse click of a hyper link. We're looking here for a click on a link which refers to a file of type pdf (or anything else that's registered above). We must massage the link a little to support relative urls.

Specified by:

hyperlinkUpdate in interface HyperlinkListener

Parameters:

e - a HyperlinkEvent

getProtocolTrap

public static URLStreamHandlerFactory getProtocolTrap()

Returns:

URLStreamHandlerFactory