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.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
display(IConsole console)
Displays the page for the given console in this console view.IConsole
getConsole()
Returns the console currently being displayed, ornull
if noneboolean
getScrollLock()
Returns the scroll lock state of the currently active console.boolean
getWordWrap()
Returns the word wrap state of the currently active console.boolean
isPinned()
Returns whether this console view is currently pinned to a specific console.void
pin(IConsole console)
Deprecated.rather than pinning a specific console, a console view is pinned - usesetPinned(boolean)
void
setPinned(boolean pin)
Pins this console view.void
setScrollLock(boolean scrollLock)
Sets the scroll lock state of the currently active console.void
setWordWrap(boolean wordWrap)
Sets the word wrap state of the currently active console.void
warnOfContentChange(IConsole console)
Warns that the content of the given console has changed.-
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
-
Methods inherited from interface org.eclipse.ui.console.IScrollLockStateProvider
getAutoScrollLock, setAutoScrollLock
-
Methods inherited from interface org.eclipse.ui.IViewPart
getViewSite, init, init, saveState
-
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
-
-
-
-
Method Detail
-
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 benull
-
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 - usesetPinned(boolean)
Displays and pins the given console in this console view. No other console can be displayed until this console view is un-pinned. Specifyingnull
un-pins this console- Parameters:
console
- console to pin, ornull
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, ornull
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 interfaceIScrollLockStateProvider
- Parameters:
scrollLock
-true
to turn scroll lock on, otherwisefalse
- Since:
- 3.1
-
getScrollLock
boolean getScrollLock()
Returns the scroll lock state of the currently active console.- Specified by:
getScrollLock
in interfaceIScrollLockStateProvider
- 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, otherwisefalse
- 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
-
-