Class HtmlPanel
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,FrameContext
- Direct Known Subclasses:
SimpleBrowserFrame
HtmlPanel
class is a Swing
component that can render a HTML DOM. It uses
either HtmlBlockPanel
or FrameSetPanel
internally, depending on whether the document
is determined to be a FRAMESET or not.
Invoke method setDocument(Document, HtmlRendererContext)
in order to schedule a document for rendering.
- See Also:
-
Nested Class Summary
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
FieldsFields inherited from class javax.swing.JComponent
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
accessibleContext, 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds listener of selection changes.void
Clears the current document if any.boolean
copy()
Copies the current selection, if any, into the clipboard.protected FrameSetPanel
Method invoked internally to create aFrameSetPanel
.protected HtmlBlockPanel
createHtmlBlockPanel
(UserAgentContext ucontext, HtmlRendererContext rcontext) Method invoked internally to create aHtmlBlockPanel
.void
delayedRelayout
(NodeImpl node) Invalidates the layout of the given node and schedules it to be layed out later.void
expandSelection
(RenderableSpot rpoint) Internal method used to expand the selection to the given point.Gets the rootRenderable
of the HTML block.Gets an instance ofFrameSetPanel
in case the currently rendered page is a FRAMESET.Gets the HTML DOM node currently rendered if any.Gets a DOM node enclosing the selection.Gets the selection text.boolean
Returns true only if the current block has a selection.void
Removes a listener of selection changes that was previously added.void
resetSelection
(RenderableSpot rpoint) Internal method used to reset the selection so that it is empty at the given point.void
scroll
(int x, int y) Scrolls the document such that x and y coordinates are placed in the upper-left corner of the panel.void
scrollBy
(int x, int y) void
If the current document is not a FRAMESET, this method scrolls the body area to the given location.void
Scrolls the body area to the node given, if it is part of the current document.void
scrollToElement
(String nameOrId) Scrolls to the element identified by the given ID in the current document.void
setDefaultMarginInsets
(Insets insets) Sets the default margin insets.void
setDefaultOverflowX
(int overflow) Sets the default horizontal overflow.void
setDefaultOverflowY
(int overflow) Sets the default vertical overflow.void
setDocument
(Document node, HtmlRendererContext rcontext) Sets an HTML DOM node and invalidates the component so it is rendered as soon as possible in the GUI thread.void
setHtml
(String htmlSource, String uri, HtmlRendererContext rcontext) Renders HTML given as a string.void
setPreferredWidth
(int width) Sets a preferred width that serves as a hint in calculating the preferred size of theHtmlPanel
.Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, 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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
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, setLayout, transferFocusDownCycle, validate, 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, getAccessibleContext, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
htmlBlockPanel
-
frameSetPanel
-
-
Constructor Details
-
HtmlPanel
public HtmlPanel()Constructs anHtmlPanel
.
-
-
Method Details
-
setPreferredWidth
public void setPreferredWidth(int width) Sets a preferred width that serves as a hint in calculating the preferred size of theHtmlPanel
. Note that the preferred size can only be calculated when a document is available, and it will vary during incremental rendering.This method currently does not have any effect when the document is a FRAMESET.
Note also that setting the preferred width (to a value other than
-1
) will negatively impact performance.- Parameters:
width
- The preferred width, or-1
to unset.
-
scrollTo
If the current document is not a FRAMESET, this method scrolls the body area to the given location.This method should be called from the GUI thread.
- Parameters:
bounds
- The bounds in the scrollable block area that should become visible.xIfNeeded
- If this parameter is true, scrolling will only occur if the requested bounds are not currently visible horizontally.yIfNeeded
- If this parameter is true, scrolling will only occur if the requested bounds are not currently visible vertically.
-
scrollTo
Scrolls the body area to the node given, if it is part of the current document.This method should be called from the GUI thread.
- Parameters:
node
- A DOM node.
-
getBlockRenderable
Gets the rootRenderable
of the HTML block. It returnsnull
for FRAMESETs. -
getFrameSetPanel
Gets an instance ofFrameSetPanel
in case the currently rendered page is a FRAMESET.Note: This method should be invoked in the GUI thread.
- Returns:
- A
FrameSetPanel
instance ornull
if the document currently rendered is not a FRAMESET.
-
createHtmlBlockPanel
protected HtmlBlockPanel createHtmlBlockPanel(UserAgentContext ucontext, HtmlRendererContext rcontext) Method invoked internally to create aHtmlBlockPanel
. It is made available so it can be overridden. -
createFrameSetPanel
Method invoked internally to create aFrameSetPanel
. It is made available so it can be overridden. -
scroll
public void scroll(int x, int y) Scrolls the document such that x and y coordinates are placed in the upper-left corner of the panel.This method may be called outside of the GUI Thread.
- Parameters:
x
- The x coordinate.y
- The y coordinate.
-
scrollBy
public void scrollBy(int x, int y) -
clearDocument
public void clearDocument()Clears the current document if any. If called outside the GUI thread, the operation will be scheduled to be performed in the GUI thread. -
setDocument
Sets an HTML DOM node and invalidates the component so it is rendered as soon as possible in the GUI thread.If this method is called from a thread that is not the GUI dispatch thread, the document is scheduled to be set later. Note that
preferred size
calculations should be done in the GUI dispatch thread for this reason.- Parameters:
node
- This should normally be a Document instance obtained withDocumentBuilderImpl
.rcontext
- A renderer context.- See Also:
-
scrollToElement
Scrolls to the element identified by the given ID in the current document.If this method is invoked outside the GUI thread, the operation is scheduled to be performed as soon as possible in the GUI thread.
- Parameters:
nameOrId
- The name or ID of the element in the document.
-
setHtml
Renders HTML given as a string.- Parameters:
htmlSource
- The HTML source code.uri
- A base URI used to resolve item URIs.rcontext
- TheHtmlRendererContext
instance.- See Also:
-
getRootNode
Gets the HTML DOM node currently rendered if any. -
expandSelection
Internal method used to expand the selection to the given point.Note: This method should be invoked in the GUI thread.
- Specified by:
expandSelection
in interfaceFrameContext
-
resetSelection
Internal method used to reset the selection so that it is empty at the given point. This is what is called when the user clicks on a point in the document.Note: This method should be invoked in the GUI thread.
- Specified by:
resetSelection
in interfaceFrameContext
-
getSelectionText
Gets the selection text.Note: This method should be invoked in the GUI thread.
-
getSelectionNode
Gets a DOM node enclosing the selection. The node returned should be the inner-most node that encloses both selection start and end points. Note that the selection end point may be just outside of the selection.Note: This method should be invoked in the GUI thread.
- Returns:
- A node enclosing the current selection, or
null
if there is no such node. It also returnsnull
for FRAMESETs.
-
hasSelection
public boolean hasSelection()Returns true only if the current block has a selection. This method has no effect in FRAMESETs at the moment. -
copy
public boolean copy()Copies the current selection, if any, into the clipboard. This method has no effect in FRAMESETs at the moment. -
addSelectionChangeListener
Adds listener of selection changes. Note that it does not have any effect on FRAMESETs.- Parameters:
listener
- An instance ofSelectionChangeListener
.
-
removeSelectionChangeListener
Removes a listener of selection changes that was previously added. -
setDefaultMarginInsets
Sets the default margin insets. Note that in the root block, the margin behaves like padding.This method has no effect on FRAMESETs.
- Parameters:
insets
- The default margin insets.
-
setDefaultOverflowX
public void setDefaultOverflowX(int overflow) Sets the default horizontal overflow.This method has no effect on FRAMESETs.
- Parameters:
overflow
- SeeRenderState
.
-
setDefaultOverflowY
public void setDefaultOverflowY(int overflow) Sets the default vertical overflow.This method has no effect on FRAMESETs.
- Parameters:
overflow
- SeeRenderState
.
-
delayedRelayout
Invalidates the layout of the given node and schedules it to be layed out later. Multiple invalidations may be processed in a single document layout.- Specified by:
delayedRelayout
in interfaceFrameContext
-