Package org.eclipse.ui.console

Interface IConsoleView

All Superinterfaces:
IAdaptable, IPersistable, IScrollLockStateProvider, IViewPart, IWorkbenchPart
public interface IConsoleView extends IViewPart, IScrollLockStateProvider
A view that displays consoles registered with the console manager.
Since:
3.0
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

  • Method Details

    • display

      void display(IConsole console)
      Displays the page for the given console in this console view. Has no effect if this console view has a pinned console.
      Parameters:
      console - console to display, cannot be null

    • setPinned

      void setPinned(boolean pin)
      Pins this console view. No other console page will be displayed until this console view is un-pinned.
      Parameters:
      pin - true to pin the current console to the top of the stack, false otherwise
      Since:
      3.1

    • pin

      @Deprecated void pin(IConsole console)
      Deprecated.
      rather than pinning a specific console, a console view is pinned - use setPinned(boolean)
      Displays and pins the given console in this console view. No other console can be displayed until this console view is un-pinned. Specifying null un-pins this console
      Parameters:
      console - console to pin, or null to un-pin

    • isPinned

      boolean isPinned()
      Returns whether this console view is currently pinned to a specific console.
      Returns:
      whether this console view is currently pinned to a specific console

    • getConsole

      IConsole getConsole()
      Returns the console currently being displayed, or null if none
      Returns:
      the console currently being displayed, or null if none

    • warnOfContentChange

      void warnOfContentChange(IConsole console)
      Warns that the content of the given console has changed.
      Parameters:
      console - the console that has changed

    • setScrollLock

      void setScrollLock(boolean scrollLock)
      Sets the scroll lock state of the currently active console.
      Specified by:
      setScrollLock in interface IScrollLockStateProvider
      Parameters:
      scrollLock - true to turn scroll lock on, otherwise false
      Since:
      3.1

    • getScrollLock

      boolean getScrollLock()
      Returns the scroll lock state of the currently active console.
      Specified by:
      getScrollLock in interface IScrollLockStateProvider
      Returns:
      true if scroll lock is on, false otherwise
      Since:
      3.1

    • setWordWrap

      void setWordWrap(boolean wordWrap)
      Sets the word wrap state of the currently active console.
      Parameters:
      wordWrap - true to turn word wrap on, otherwise false
      Since:
      3.6

    • getWordWrap

      boolean getWordWrap()
      Returns the word wrap state of the currently active console.
      Returns:
      true if word wrap is on, false otherwise
      Since:
      3.6