Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.ui.forms.widgets
Class ScrolledFormText

    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.custom.ScrolledComposite
                          org.eclipse.ui.forms.widgets.SharedScrolledComposite
                              org.eclipse.ui.forms.widgets.ScrolledFormText

All Implemented Interfaces:
  Drawable

public final class ScrolledFormText
extends SharedScrolledComposite

ScrolledFormText is a control that is capable of scrolling an instance of the FormText class. It should be created in a parent that will allow it to use all the available area (for example, a shell, a view or an editor). The form text can be created by the class itself, or set from outside. In the later case, the form text instance must be a direct child of the ScrolledFormText instance.

The class assumes that text to be rendered contains formatting tags. In case of a string, it will enclose the text in 'form' root element if missing from the text as a convinience. For example:

      ftext.setText("<p>Some text here</>");

will not cause an error. The same behavior does not exist for content from the input stream, however - it must be well formed in that case.

Since:
  3.0
See Also:
  `FormText`

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control
`handle`

Constructor Summary
`ScrolledFormText(Composite parent, boolean createFormText)` Creates the new scrolled text instance in the provided parent
`ScrolledFormText(Composite parent, int style, boolean createFormText)` Creates the new scrolled text instance in the provided parent

Method Summary
`FormText` | `getFormText()` Returns the instance of the form text.
`void` | `setBackground(Color bg)` Sets the background color of the scrolled form text.
`void` | `setContent(Control c)` The class sets the content widget.
`void` | `setContents(InputStream is)` Sets the contents to rendered in the scrolled form text.
`void` | `setForeground(Color fg)` Sets the foreground color of the scrolled form text.
`void` | `setFormText(FormText formText)` Sets the form text to be managed by this scrolled form text.
`void` | `setText(String text)` Sets the text to be rendered in the scrolled form text.

Methods inherited from class org.eclipse.ui.forms.widgets.SharedScrolledComposite
`reflow, setFocus, setFont`

Methods inherited from class org.eclipse.swt.custom.ScrolledComposite
`computeSize, getAlwaysShowScrollBars, getContent, getOrigin, layout, setAlwaysShowScrollBars, setExpandHorizontal, setExpandVertical, setLayout, setMinHeight, setMinSize, setMinSize, setMinWidth, setOrigin, setOrigin`

Methods inherited from class org.eclipse.swt.widgets.Composite
`checkSubclass, getChildren, getLayout, getTabList, layout, setTabList`

Methods inherited from class org.eclipse.swt.widgets.Scrollable
`computeTrim, getClientArea, getHorizontalBar, getVerticalBar`

Methods inherited from class org.eclipse.swt.widgets.Control
`addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBounds, setBounds, setCapture, setCursor, setEnabled, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update`

Methods inherited from class org.eclipse.swt.widgets.Widget
`addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### ScrolledFormText

    public ScrolledFormText(Composite parent,
                            boolean createFormText)

  Creates the new scrolled text instance in the provided parent

Parameters:
  `parent` - the parent composite
  `createFormText` - if `true`, enclosing form text instance will be created in this constructor.

### ScrolledFormText

    public ScrolledFormText(Composite parent,
                            int style,
                            boolean createFormText)

  Creates the new scrolled text instance in the provided parent

Parameters:
  `parent` - the parent composite
  `style` - the style to pass to the scrolled composite
  `createFormText` - if `true`, enclosing form text instance will be created in this constructor.

Method Detail

### setFormText

    public void setFormText(FormText formText)

  Sets the form text to be managed by this scrolled form text. The instance must be a direct child of this class. If this method is used, `false` must be passed in either of the constructors to avoid creating form text instance.

  Parameters:
    `formText` - the form text instance to use.

### setForeground

    public void setForeground(Color fg)

  Sets the foreground color of the scrolled form text.

  Overrides:
    `setForeground` in class `SharedScrolledComposite`
  Parameters:
    `fg` - the foreground color

### setBackground

    public void setBackground(Color bg)

  Sets the background color of the scrolled form text.

  Overrides:
    `setBackground` in class `SharedScrolledComposite`
  Parameters:
    `bg` - the new background color

### setContent

    public final void setContent(Control c)

  The class sets the content widget. This method should not be called by classes that instantiate this widget.

  Overrides:
    `setContent` in class `SharedScrolledComposite`
  Parameters:
    `c` - content control

### setText

    public void setText(String text)

  Sets the text to be rendered in the scrolled form text. The text must contain formatting tags.

  Parameters:
    `text` - the text to be rendered

### setContents

    public void setContents(InputStream is)

  Sets the contents to rendered in the scrolled form text. The stream must contain formatting tags. The caller is responsible for closing the input stream. The call may be long running. For best results, call this method from another thread and call 'reflow' when done (but make both calls using 'Display.asyncExec' because these calls must be made in the event dispatching thread).

  Parameters:
    `is` - content input stream

### getFormText

    public FormText getFormText()

  Returns the instance of the form text.

  Returns:
    the form text instance

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.