Package org.xhtmlrenderer.swing

Class RootPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.xhtmlrenderer.swing.RootPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, FSCanvas, UserInterface, RepaintListener

Direct Known Subclasses:

BasicPanel

@ParametersAreNonnullByDefault
public class RootPanel
extends JPanel
implements Scrollable, UserInterface, FSCanvas, RepaintListener

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	Description
Element	active_element
protected Document	doc
Element	focus_element
Element	hovered_element
protected SharedContext	sharedContext

Fields 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

Constructor	Description
RootPanel()

Method Summary

Modifier and Type	Method	Description
void	addDocumentListener(DocumentListener listener)	Adds the specified Document listener to receive Document events from this component.
void	addNotify()	Overrides the default implementation to test for and configure any JScrollPane parent.
void	doDocumentLayout(Graphics g)
void	doLayout()
Box	find(int x, int y)
Box	find(MouseEvent e)
protected void	fireDocumentLoaded()
protected void	fireDocumentStarted()
protected void	fireOnLayoutException(Throwable t)
protected void	fireOnRenderException(Throwable t)
CellRendererPane	getCellRendererPane()
protected JScrollPane	getEnclosingScrollPane()
Rectangle	getFixedRectangle()	Gets the fixedRectangle attribute of the BasicPanel object
LayoutContext	getLayoutContext()
double	getLayoutWidth()
Dimension	getPreferredScrollableViewportSize()
Box	getRootBox()
Layer	getRootLayer()
Rectangle	getScreenExtents()
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
boolean	getScrollableTracksViewportHeight()
boolean	getScrollableTracksViewportWidth()
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
SharedContext	getSharedContext()
protected boolean	hasDocumentListeners()
protected void	init()
boolean	isActive(Element e)	Gets the active attribute of the UserInterface object
boolean	isDefaultFontFromComponent()
protected boolean	isExtentsHaveChanged()
boolean	isFocus(Element e)	Gets the focus attribute of the UserInterface object
boolean	isHover(Element e)	Gets the hover attribute of the UserInterface object
protected boolean	isNeedRelayout()
boolean	isPrintView()
protected LayoutContext	newLayoutContext(Graphics2D g)
RenderingContext	newRenderingContext(Graphics2D g)
protected void	relayout()
void	removeDocumentListener(DocumentListener listener)	Removes the specified Document listener from receive Document events from this component.
void	removeNotify()	Overrides the default implementation unconfigure any JScrollPane parent.
void	repaintRequested(boolean doLayout)
void	resetScrollPosition()
void	setDefaultFontFromComponent(boolean defaultFontFromComponent)
void	setDocument(Document doc, String url, NamespaceHandler nsh)
protected void	setEnclosingScrollPane(JScrollPane scrollPane)	The method is invoked by addNotify() and removeNotify() to ensure that any enclosing JScrollPane works correctly with this panel.
protected void	setNeedRelayout(boolean needRelayout)
void	setRootBox(Box rootBox)
void	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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setOpaque, 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, 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, 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, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xhtmlrenderer.extend.FSCanvas

getX, getY

Field Detail

sharedContext

protected SharedContext sharedContext

doc

protected Document doc

hovered_element

public Element hovered_element

active_element

public Element active_element

focus_element

public Element focus_element

Constructor Detail

RootPanel

public RootPanel()

Method Detail

getSharedContext

public SharedContext getSharedContext()

getLayoutContext

public LayoutContext getLayoutContext()

setDocument

public void setDocument(Document doc,
                        @Nullable
                        String url,
                        NamespaceHandler nsh)

resetScrollPosition

public void resetScrollPosition()

setEnclosingScrollPane

protected void setEnclosingScrollPane(@Nullable
                                      JScrollPane scrollPane)

The method is invoked by addNotify() and removeNotify() to ensure that any enclosing JScrollPane works correctly with this panel. This method can be safely invoked with a null scrollPane.

Parameters:

scrollPane - the enclosing JScrollPane or null if the panel is no longer enclosed in a JScrollPane.

getEnclosingScrollPane

protected JScrollPane getEnclosingScrollPane()

getFixedRectangle

public Rectangle getFixedRectangle()

Gets the fixedRectangle attribute of the BasicPanel object

Specified by:

getFixedRectangle in interface FSCanvas

Returns:

The fixedRectangle value

addNotify

public void addNotify()

Overrides the default implementation to test for and configure any JScrollPane parent.

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides the default implementation unconfigure any JScrollPane parent.

Overrides:

removeNotify in class JComponent

init

protected final void init()

newRenderingContext

public RenderingContext newRenderingContext(Graphics2D g)

newLayoutContext

protected LayoutContext newLayoutContext(Graphics2D g)

getScreenExtents

public Rectangle getScreenExtents()

doDocumentLayout

public void doDocumentLayout(@Nullable
                             Graphics g)

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.

hasDocumentListeners

protected boolean hasDocumentListeners()

fireDocumentStarted

protected void fireDocumentStarted()

fireDocumentLoaded

protected void fireDocumentLoaded()

fireOnLayoutException

protected void fireOnLayoutException(Throwable t)

fireOnRenderException

protected void fireOnRenderException(Throwable t)

getCellRendererPane

public CellRendererPane getCellRendererPane()

Returns:

a CellRendererPane suitable for drawing components in (with CellRendererPane.paintComponent)

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

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

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

Parameters:

e - PARAM

Returns:

The focus value

relayout

protected void relayout()

getLayoutWidth

public double getLayoutWidth()

isPrintView

public boolean isPrintView()

getRootBox

public Box getRootBox()

setRootBox

public void setRootBox(@Nullable
                       Box rootBox)

getRootLayer

public Layer getRootLayer()

find

public Box find(MouseEvent e)

find

public Box find(int x,
                int y)

doLayout

public void doLayout()

Overrides:

doLayout in class Container

validate

public void validate()

Overrides:

validate in class Container

isExtentsHaveChanged

protected boolean isExtentsHaveChanged()

isNeedRelayout

protected boolean isNeedRelayout()

setNeedRelayout

protected void setNeedRelayout(boolean needRelayout)

repaintRequested

public void repaintRequested(boolean doLayout)

Specified by:

repaintRequested in interface RepaintListener

isDefaultFontFromComponent

public boolean isDefaultFontFromComponent()

setDefaultFontFromComponent

public void setDefaultFontFromComponent(boolean defaultFontFromComponent)

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Specified by:

getScrollableUnitIncrement in interface Scrollable

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Specified by:

getScrollableBlockIncrement in interface Scrollable

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight in interface Scrollable