KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > console > IConsoleView


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