Class AbstractFormattedTextViewer

  • All Implemented Interfaces:
    org.eclipse.swt.graphics.Drawable
    Direct Known Subclasses:
    FormattedTextViewer, FormattedTextViewerFx

    public abstract class AbstractFormattedTextViewer
    extends org.eclipse.swt.widgets.Composite
    Base class for Control to display formatted text.
    • Field Summary

      • Fields inherited from class org.eclipse.swt.widgets.Control

        handle
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractFormattedTextViewer​(org.eclipse.swt.widgets.Composite parent)
      Creates new instance of the control without any views attached.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void hideScrollBars​(boolean value)
      Hides scroll bars of the viewer.
      abstract void resizeView​(org.eclipse.swt.graphics.Rectangle rect, Runnable onContentLoaded)
      Resizes view containment.
      abstract void updateFormattedStringSettings​(FormattedStringSettings settings, Runnable onContentLoaded)
      Updates the FormattedStringSettings.
      • 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, setLayout, setLayoutDeferred, setTabList
      • 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, 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, 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, setFont, 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, toString
      • Methods inherited from interface org.eclipse.swt.graphics.Drawable

        isAutoScalable
    • Constructor Detail

      • AbstractFormattedTextViewer

        public AbstractFormattedTextViewer​(org.eclipse.swt.widgets.Composite parent)
        Creates new instance of the control without any views attached. Can be used by descendants to attach custom views of a formatted text.
        Parameters:
        parent - parent control, cannot be null
    • Method Detail

      • updateFormattedStringSettings

        public abstract void updateFormattedStringSettings​(FormattedStringSettings settings,
                                                           Runnable onContentLoaded)
        Updates the FormattedStringSettings. If default font style is changed you should use this method to set correct settings.
        Parameters:
        settings - new formatted text settings, can be null
        onContentLoaded - callback to be called when content has been loaded, cannot be null
      • resizeView

        public abstract void resizeView​(org.eclipse.swt.graphics.Rectangle rect,
                                        Runnable onContentLoaded)
        Resizes view containment.
        Parameters:
        rect - new size, cannot be null
        onContentLoaded - callback to be called when content has been loaded, can be null
      • hideScrollBars

        public void hideScrollBars​(boolean value)
        Hides scroll bars of the viewer.
        Parameters:
        hide - if true, then scroll bars will never appear