Class BasicRenderer

java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.Canvas
org.xhtmlrenderer.swt.BasicRenderer
All Implemented Interfaces:
EventListener, org.eclipse.swt.events.PaintListener, org.eclipse.swt.graphics.Drawable, org.eclipse.swt.internal.SWTEventListener, FSCanvas, UserInterface
public class BasicRenderer extends org.eclipse.swt.widgets.Canvas implements org.eclipse.swt.events.PaintListener, UserInterface, FSCanvas
Renders XML+CSS using SWT in a widget (a Composite). Scrollbars are handled automatically.
Author:
Vianney le Clément

  • Field Summary

    Fields inherited from class org.eclipse.swt.widgets.Composite

    embeddedHandle

    Fields inherited from class org.eclipse.swt.widgets.Widget

    handle

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicRenderer(org.eclipse.swt.widgets.Composite parent, int style)
     
    BasicRenderer(org.eclipse.swt.widgets.Composite parent, int style, UserAgentCallback uac)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDocumentListener(DocumentListener listener)
     
    org.eclipse.swt.graphics.Point
    computeSize(int wHint, int hHint, boolean changed)
     
    void
    decrementFontSize()
    Decrements all rendered fonts on the current document by the current scaling factor for the panel.
    protected void
    doLayout()
     
    protected void
    doRender(RenderingContext c)
     
    Box
    find(int x, int y)
     
    protected void
    fireDocumentLoaded()
     
    protected void
    fireOnLayoutException(Throwable t)
     
    protected void
    fireOnRenderException(Throwable t)
     
    Element
    getActive_element()
     
    Document
    getDocument()
     
    String
    getDocumentTitle()
     
    Rectangle
    getFixedRectangle()
     
    Element
    getFocus_element()
     
    Element
    getHovered_element()
     
    protected Rectangle
    getInitialExtents(LayoutContext c)
     
    LayoutContext
    getLayoutContext()
     
    float
    getMaxFontScale()
    Returns the maximum font scaling that may be applied, e.g. 3 times assigned font size.
    float
    getMinFontScale()
    Returns the minimum font scaling that may be applied, e.g. 0.5 times assigned font size.
    org.eclipse.swt.graphics.Point
    getOrigin()
     
    @Nullable Box
    getRootBox()
     
    @Nullable Layer
    getRootLayer()
     
    org.eclipse.swt.graphics.Point
    getScreenSize()
     
    SharedContext
    getSharedContext()
     
    int
    getX()
     
    int
    getY()
     
    void
    incrementFontSize()
    Increments all rendered fonts on the current document by the current scaling factor for the panel.
    void
    invalidate()
    Invalidate the whole view.
    void
    invalidate(org.eclipse.swt.graphics.Rectangle rect)
    Redraw only rect.
    boolean
    isActive(Element e)
    Gets the active attribute of the UserInterface object
    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
    isPrint()
     
    protected Document
    loadDocument(String uri)
     
    protected LayoutContext
    newLayoutcontext()
     
    protected RenderingContext
    newRenderingContext(org.eclipse.swt.graphics.GC gc)
     
    void
    paintControl(org.eclipse.swt.events.PaintEvent e)
     
    void
    relayout()
    Do a full relayout and redraw
    void
    reload()
    Reload the current document.
    void
    removeDocumentListener(DocumentListener listener)
     
    void
    resetFontSize()
    Resets all rendered fonts on the current document to the font size specified in the document's styling instructions.
    protected void
    scrollTo(org.eclipse.swt.graphics.Point pt)
     
    void
    setActive_element(Element active_element)
     
    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
    setDocument(Document doc, String url)
     
    void
    setDocument(Document doc, 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
    setFocus_element(Element focus_element)
     
    void
    setFontScalingFactor(float scaling)
    Sets the scaling factor used by incrementFontSize() and decrementFontSize()--both scale the font up or down by this scaling factor.
    void
    setHovered_element(Element hovered_element)
     
    void
    setLayout(org.eclipse.swt.widgets.Layout layout)
    A Renderer has no layout!
    void
    setMaxFontScale(float f)
    Sets the maximum font scaling that may be applied, e.g. 3 times assigned font size.
    void
    setMinFontScale(float f)
    Sets the minimum font scaling that may be applied, e.g. 3 times assigned font size.
    void
    setOrigin(org.eclipse.swt.graphics.Point pt)
    Set the origin of the view.
    void
    setPrint(boolean print)
     
    protected boolean
    updateScrollBars()
    Update the scrollbars

    Methods inherited from class org.eclipse.swt.widgets.Canvas

    drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME

    Methods inherited from class org.eclipse.swt.widgets.Composite

    changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayoutDeferred, setTabList, toString

    Methods inherited from class org.eclipse.swt.widgets.Scrollable

    computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

    Methods inherited from class org.eclipse.swt.widgets.Control

    addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

    Methods inherited from class org.eclipse.swt.widgets.Widget

    addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData

    Methods inherited from class Object

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

  • Constructor Details

    • BasicRenderer

      public BasicRenderer(org.eclipse.swt.widgets.Composite parent, int style)

    • BasicRenderer

      public BasicRenderer(org.eclipse.swt.widgets.Composite parent, int style, UserAgentCallback uac)

  • Method Details

    • addDocumentListener

      public void addDocumentListener(DocumentListener listener)

    • removeDocumentListener

      public void removeDocumentListener(DocumentListener listener)

    • fireDocumentLoaded

      protected void fireDocumentLoaded()

    • fireOnLayoutException

      protected void fireOnLayoutException(Throwable t)

    • fireOnRenderException

      protected void fireOnRenderException(Throwable t)

    • setLayout

      public void setLayout(org.eclipse.swt.widgets.Layout layout)
      A Renderer has no layout!
      Overrides:
      setLayout in class org.eclipse.swt.widgets.Composite

    • relayout

      public void relayout()
      Do a full relayout and redraw

    • invalidate

      public void invalidate()
      Invalidate the whole view. Redraw everything.

    • invalidate

      public void invalidate(org.eclipse.swt.graphics.Rectangle rect)
      Redraw only rect.
      Parameters:
      rect - the rectangle

    • newLayoutcontext

      protected LayoutContext newLayoutcontext()
      Returns:
      a new LayoutContext

    • newRenderingContext

      protected RenderingContext newRenderingContext(org.eclipse.swt.graphics.GC gc)
      Returns:
      a new RenderingContext

    • getInitialExtents

      protected Rectangle getInitialExtents(LayoutContext c)

    • getScreenSize

      public org.eclipse.swt.graphics.Point getScreenSize()
      Returns:
      the size of the drawable screen

    • computeSize

      public org.eclipse.swt.graphics.Point computeSize(int wHint, int hHint, boolean changed)
      Overrides:
      computeSize in class org.eclipse.swt.widgets.Control

    • getFixedRectangle

      public Rectangle getFixedRectangle()
      Specified by:
      getFixedRectangle in interface FSCanvas

    • getX

      public int getX()
      Specified by:
      getX in interface FSCanvas

    • getY

      public int getY()
      Specified by:
      getY in interface FSCanvas

    • getOrigin

      public org.eclipse.swt.graphics.Point getOrigin()
      Returns:
      the origin of the view

    • setOrigin

      public void setOrigin(org.eclipse.swt.graphics.Point pt)
      Set the origin of the view. NOTE: this won't be done immediately.

    • scrollTo

      protected void scrollTo(org.eclipse.swt.graphics.Point pt)

    • updateScrollBars

      protected boolean updateScrollBars()
      Update the scrollbars
      Returns:
      true if we need to relayout the whole thing

    • paintControl

      public void paintControl(org.eclipse.swt.events.PaintEvent e)
      Specified by:
      paintControl in interface org.eclipse.swt.events.PaintListener

    • doLayout

      protected void doLayout()

    • doRender

      protected void doRender(RenderingContext c)

    • getDocument

      public Document getDocument()

    • reload

      public void reload()
      Reload the current document.

    • setDocument

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

    • 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

      public void setDocument(InputStream stream, String url)

    • 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

    • loadDocument

      protected Document loadDocument(String uri)

    • getDocumentTitle

      public String getDocumentTitle()

    • getRootBox

      public @Nullable Box getRootBox()

    • getRootLayer

      public @Nullable Layer getRootLayer()

    • getSharedContext

      public SharedContext getSharedContext()

    • getLayoutContext

      public LayoutContext getLayoutContext()

    • find

      public Box find(int x, int y)

    • 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

    • getHovered_element

      public Element getHovered_element()

    • setHovered_element

      public void setHovered_element(Element hovered_element)

    • 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

    • getActive_element

      public Element getActive_element()

    • setActive_element

      public void setActive_element(Element active_element)

    • 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

    • getFocus_element

      public Element getFocus_element()

    • setFocus_element

      public void setFocus_element(Element focus_element)

    • isPrint

      public boolean isPrint()

    • setPrint

      public void setPrint(boolean print)

    • setFontScalingFactor

      public void setFontScalingFactor(float scaling)
      Sets the scaling factor used by incrementFontSize() and decrementFontSize()--both scale the font up or down by this scaling factor. The scaling roughly modifies the font size as a multiplier or divisor. A scaling factor of 1.2 applied against a font size of 10pt results in a scaled font of 12pt. The default scaling factor is 1.2F.

    • incrementFontSize

      public void incrementFontSize()
      Increments all rendered fonts on the current document by the current scaling factor for the panel. Scaling applies cumulatively, which means that multiple calls to this method scale fonts larger and larger by applying the current scaling factor against itself. You can modify the scaling factor by setFontScalingFactor(float), and reset to the document's specified font size with resetFontSize().

    • resetFontSize

      public void resetFontSize()
      Resets all rendered fonts on the current document to the font size specified in the document's styling instructions.

    • decrementFontSize

      public void decrementFontSize()
      Decrements all rendered fonts on the current document by the current scaling factor for the panel. Scaling applies cumulatively, which means that multiple calls to this method scale fonts smaller and smaller by applying the current scaling factor against itself. You can modify the scaling factor by setFontScalingFactor(float), and reset to the document's specified font size with resetFontSize().

    • getMaxFontScale

      public float getMaxFontScale()
      Returns the maximum font scaling that may be applied, e.g. 3 times assigned font size.

    • getMinFontScale

      public float getMinFontScale()
      Returns the minimum font scaling that may be applied, e.g. 0.5 times assigned font size.

    • setMaxFontScale

      public void setMaxFontScale(float f)
      Sets the maximum font scaling that may be applied, e.g. 3 times assigned font size. Calling incrementFontSize() after this scale has been reached doesn't have an effect.

    • setMinFontScale

      public void setMinFontScale(float f)
      Sets the minimum font scaling that may be applied, e.g. 3 times assigned font size. Calling decrementFontSize() after this scale has been reached doesn't have an effect.