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 voiddisplay(IConsole console)Displays the page for the given console in this console view.IConsolegetConsole()Returns the console currently being displayed, ornullif nonebooleangetScrollLock()Returns the scroll lock state of the currently active console.booleangetWordWrap()Returns the word wrap state of the currently active console.booleanisPinned()Returns whether this console view is currently pinned to a specific console.voidpin(IConsole console)Deprecated.rather than pinning a specific console, a console view is pinned - usesetPinned(boolean)voidsetPinned(boolean pin)Pins this console view.voidsetScrollLock(boolean scrollLock)Sets the scroll lock state of the currently active console.voidsetWordWrap(boolean wordWrap)Sets the word wrap state of the currently active console.voidwarnOfContentChange(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-trueto pin the current console to the top of the stack,falseotherwise- 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. Specifyingnullun-pins this console- Parameters:
console- console to pin, ornullto 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, ornullif none- Returns:
- the console currently being displayed, or
nullif 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:
setScrollLockin interfaceIScrollLockStateProvider- Parameters:
scrollLock-trueto turn scroll lock on, otherwisefalse- Since:
- 3.1
-
getScrollLock
boolean getScrollLock()
Returns the scroll lock state of the currently active console.- Specified by:
getScrollLockin interfaceIScrollLockStateProvider- Returns:
trueif scroll lock is on,falseotherwise- Since:
- 3.1
-
setWordWrap
void setWordWrap(boolean wordWrap)
Sets the word wrap state of the currently active console.- Parameters:
wordWrap-trueto turn word wrap on, otherwisefalse- Since:
- 3.6
-
getWordWrap
boolean getWordWrap()
Returns the word wrap state of the currently active console.- Returns:
trueif word wrap is on,falseotherwise- Since:
- 3.6
-
-