01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.console;
11:
12: import org.eclipse.ui.IViewPart;
13:
14: /**
15: * A view that displays consoles registered with the console manager.
16: * <p>
17: * Clients are not intended to implement this interface.
18: * </p>
19: * @since 3.0
20: */
21: public interface IConsoleView extends IViewPart {
22:
23: /**
24: * Displays the page for the given console in this console view.
25: * Has no effect if this console view has a pinned console.
26: *
27: * @param console console to display, cannot be <code>null</code>
28: */
29: public void display(IConsole console);
30:
31: /**
32: * Pins this console view. No other console page will be displayed until
33: * this console view is un-pinned.
34: *
35: * @param pin <code>true</code> to pin the current console to the
36: * top of the stack, <code>false</code> otherwise
37: * @since 3.1
38: */
39: public void setPinned(boolean pin);
40:
41: /**
42: * Displays and pins the given console in this console view. No
43: * other console can be displayed until this console view is
44: * un-pinned. Specifying <code>null</code> un-pins this console
45: *
46: * @param console console to pin, or <code>null</code> to un-pin
47: * @deprecated rather than pinning a specific console, a console view is
48: * pinned - use <code>setPinned(boolean)</code>
49: */
50: public void pin(IConsole console);
51:
52: /**
53: * Returns whether this console view is currently pinned to a
54: * specific console.
55: *
56: * @return whether this console view is currently pinned to a
57: * specific console
58: */
59: public boolean isPinned();
60:
61: /**
62: * Returns the console currently being displayed, or <code>null</code>
63: * if none
64: *
65: * @return the console currently being displayed, or <code>null</code>
66: * if none
67: */
68: public IConsole getConsole();
69:
70: /**
71: * Warns that the content of the given console has changed.
72: *
73: * @param console the console that has changed
74: */
75: public void warnOfContentChange(IConsole console);
76:
77: /**
78: * Sets the scroll lock state of the currently active console.
79: *
80: * @param scrollLock <code>true</code> to turn scroll lock on, otherwise <code>false</code>
81: * @since 3.1
82: */
83: public void setScrollLock(boolean scrollLock);
84:
85: /**
86: * Returns the scroll lock state of the currently active console.
87: *
88: * @return <code>true</code> if scroll lock is on, <code>false</code> otherwise
89: * @since 3.1
90: */
91: public boolean getScrollLock();
92:
93: }
|