org.docx4j.org.xhtmlrenderer.swing

Class BasicPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.docx4j.org.xhtmlrenderer.swing.RootPanel

org.docx4j.org.xhtmlrenderer.swing.BasicPanel

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FSCanvas, UserInterface, FormSubmissionListener, RepaintListener

Direct Known Subclasses:

XHTMLPanel

public abstract class BasicPanel
extends RootPanel
implements FormSubmissionListener

A Swing JPanel that encloses the Flying Saucer renderer for easy integration into Swing applications.

Author:

Joshua Marinacci

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected FormSubmissionListener	formSubmissionListener

Fields inherited from class org.docx4j.org.xhtmlrenderer.swing.RootPanel

active_element, doc, documentListeners, enclosingScrollPane, focus_element, hovered_element, sharedContext

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
BasicPanel()
BasicPanel(UserAgentCallback uac)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocumentListener(DocumentListener listener) Adds the specified Document listener to receive Document events from this component.
void	addMouseTrackingListener(FSMouseListener l)
void	assignPagePrintPositions(Graphics2D g)
protected void	doRender(RenderingContext c, Layer root)
Document	getDocument()
String	getDocumentTitle() Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel.
Rectangle	getFixedRectangle() Gets the fixedRectangle attribute of the BasicPanel object
List	getMouseTrackingListeners()
SharedContext	getSharedContext()
URL	getURL()
boolean	isActive(Element e) Gets the active attribute of the UserInterface object
boolean	isCenteredPagedView()
boolean	isFocus(Element e) Gets the focus attribute of the UserInterface object
boolean	isHover(Element e) Gets the hover attribute of the UserInterface object
boolean	isInteractive()
boolean	isOpaque() Returns whether the background of this BasicPanel will be painted when it is rendered.
protected Document	loadDocument(String uri)
void	paintComponent(Graphics g)
void	paintPage(Graphics2D g, int pageNo)
void	printTree()
void	reloadDocument(Document doc) Reloads the document using the same base URL and namespace handler.
void	reloadDocument(String URI) Reloads the document using the same base URL and namespace handler.
void	removeDocumentListener(DocumentListener listener) Removes the specified Document listener from receive Document events from this component.
void	removeMouseTrackingListener(FSMouseListener l)
protected void	resetMouseTracker()
void	scrollTo(Point pt) Scroll the panel to make the specified point be on screen.
void	setCenteredPagedView(boolean centeredPagedView)
void	setDocument(Document doc, String url)
protected void	setDocument(InputStream stream, String url)
void	setDocument(InputStream stream, String url, NamespaceHandler nsh)
void	setDocument(String url)
void	setDocument(String url, NamespaceHandler nsh)
void	setDocumentFromString(String content, String url, NamespaceHandler nsh)
protected void	setDocumentRelative(String filename) Sets the new current document, where the new document is located relative, e.g using a relative URL.
void	setFormSubmissionListener(FormSubmissionListener fsl)
void	setInteractive(boolean interactive)
void	setLayout(LayoutManager l) Sets the layout attribute of the BasicPanel object Overrides the method to do nothing, since you shouldn't have a LayoutManager on an FS panel.
void	setOpaque(boolean opaque) Specifies whether the background of this BasicPanel will be painted when it is rendered.
void	setSharedContext(SharedContext ctx)
void	setSize(Dimension d)
void	submit(String url) Called by XhtmlForm when a form is submitted.

Methods inherited from class org.docx4j.org.xhtmlrenderer.swing.RootPanel

addNotify, componentHidden, componentMoved, componentResized, componentShown, doDocumentLayout, find, find, fireDocumentLoaded, fireDocumentStarted, fireOnLayoutException, fireOnRenderException, getCellRendererPane, getLayoutContext, getLayoutWidth, getRootBox, getRootLayer, getScreenExtents, init, isDefaultFontFromComponent, isExtentsHaveChanged, isNeedRelayout, isPrintView, newLayoutContext, newRenderingContext, relayout, removeNotify, repaintRequested, resetScrollPosition, setDefaultFontFromComponent, setDocument, setEnclosingScrollPane, setNeedRelayout, setRootBox, validate

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docx4j.org.xhtmlrenderer.extend.FSCanvas

getX, getY

Field Detail

formSubmissionListener

protected FormSubmissionListener formSubmissionListener

Constructor Detail

BasicPanel

public BasicPanel()

BasicPanel

public BasicPanel(UserAgentCallback uac)

Method Detail

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Adds the specified Document listener to receive Document events from this component. If listener l is null, no exception is thrown and no action is performed.

Parameters:

listener - Contains the DocumentListener for DocumentEvent data.

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Removes the specified Document listener from receive Document events from this component. If listener l is null, no exception is thrown and no action is performed.

Parameters:

listener - Contains the DocumentListener to remove.

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

doRender

protected void doRender(RenderingContext c,
            Layer root)

paintPage

public void paintPage(Graphics2D g,
             int pageNo)

assignPagePrintPositions

public void assignPagePrintPositions(Graphics2D g)

printTree

public void printTree()

setLayout

public void setLayout(LayoutManager l)

Sets the layout attribute of the BasicPanel object Overrides the method to do nothing, since you shouldn't have a LayoutManager on an FS panel.

Overrides:

setLayout in class Container

Parameters:

l - The new layout value

setSharedContext

public void setSharedContext(SharedContext ctx)

setSize

public void setSize(Dimension d)

Overrides:

setSize in class Component

setDocument

public void setDocument(InputStream stream,
               String url,
               NamespaceHandler nsh)

setDocumentFromString

public void setDocumentFromString(String content,
                         String url,
                         NamespaceHandler nsh)

setDocument

public void setDocument(Document doc,
               String url)

setDocument

public void setDocument(String url)

setDocument

public void setDocument(String url,
               NamespaceHandler nsh)

setDocument

protected void setDocument(InputStream stream,
               String url)
                    throws Exception

Throws:

Exception

setDocumentRelative

protected void setDocumentRelative(String filename)

Sets the new current document, where the new document is located relative, e.g using a relative URL.

Parameters:

filename - The new document to load

reloadDocument

public void reloadDocument(String URI)

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Parameters:

URI - A URI for the Document to load, for example, file.toURL().toExternalForm().

reloadDocument

public void reloadDocument(Document doc)

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Parameters:

doc - The document to reload.

getURL

public URL getURL()

getDocument

public Document getDocument()

getDocumentTitle

public String getDocumentTitle()

Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel. For an HTML document, this will be the contents of /html/head/title.

Returns:

the document title, or "" if the namespace handler cannot find a title, or if there is no current document in the panel.

loadDocument

protected Document loadDocument(String uri)

isHover

public boolean isHover(Element e)

Description copied from interface: UserInterface

Gets the hover attribute of the UserInterface object

Specified by:

isHover in interface UserInterface

Overrides:

isHover in class RootPanel

Parameters:

e - PARAM

Returns:

The hover value

isActive

public boolean isActive(Element e)

Description copied from interface: UserInterface

Gets the active attribute of the UserInterface object

Specified by:

isActive in interface UserInterface

Overrides:

isActive in class RootPanel

Parameters:

e - PARAM

Returns:

The active value

isFocus

public boolean isFocus(Element e)

Description copied from interface: UserInterface

Gets the focus attribute of the UserInterface object

Specified by:

isFocus in interface UserInterface

Overrides:

isFocus in class RootPanel

Parameters:

e - PARAM

Returns:

The focus value

isOpaque

public boolean isOpaque()

Returns whether the background of this BasicPanel will be painted when it is rendered.

Overrides:

isOpaque in class JComponent

Returns:

true if the background of this BasicPanel will be painted, false if it will not.

setOpaque

public void setOpaque(boolean opaque)

Specifies whether the background of this BasicPanel will be painted when it is rendered.

Overrides:

setOpaque in class JComponent

Parameters:

opaque - true if the background of this BasicPanel should be painted, false if it should not.

getSharedContext

public SharedContext getSharedContext()

Overrides:

getSharedContext in class RootPanel

getFixedRectangle

public Rectangle getFixedRectangle()

Description copied from class: RootPanel

Gets the fixedRectangle attribute of the BasicPanel object

Specified by:

getFixedRectangle in interface FSCanvas

Overrides:

getFixedRectangle in class RootPanel

Returns:

The fixedRectangle value

scrollTo

public void scrollTo(Point pt)

Scroll the panel to make the specified point be on screen. Typically this will scroll the screen down to the y component of the point.

isInteractive

public boolean isInteractive()

setInteractive

public void setInteractive(boolean interactive)

addMouseTrackingListener

public void addMouseTrackingListener(FSMouseListener l)

removeMouseTrackingListener

public void removeMouseTrackingListener(FSMouseListener l)

getMouseTrackingListeners

public List getMouseTrackingListeners()

resetMouseTracker

protected void resetMouseTracker()

isCenteredPagedView

public boolean isCenteredPagedView()

setCenteredPagedView

public void setCenteredPagedView(boolean centeredPagedView)

submit

public void submit(String url)

Description copied from interface: FormSubmissionListener

Called by XhtmlForm when a form is submitted.

Specified by:

submit in interface FormSubmissionListener

Parameters:

url - the entire query string as composed from form elements and the form's action URL

setFormSubmissionListener

public void setFormSubmissionListener(FormSubmissionListener fsl)