IConsoleConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 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  
12  package org.eclipse.ui.console;
13  
14  /**
15   * Constants relating to the console plug-in.
16   * 
17   * @since 3.0
18   */
19  public interface IConsoleConstants {
20      
21      /**
22       * Console plug-in identifier (value <code>"org.eclipse.ui.console"</code>).
23       */
24      public static final String   PLUGIN_ID = ConsolePlugin.getUniqueIdentifier();
25      
26      /**
27       * Console view identifier (value <code>"org.eclipse.ui.console.ConsoleView"</code>).
28       */
29      public static final String   ID_CONSOLE_VIEW= "org.eclipse.ui.console.ConsoleView"; //$NON-NLS-1$
30  
31      /**
32       * Type identifier for MessageConsole
33       * @since 3.1
34       */
35      public static final String   MESSAGE_CONSOLE_TYPE = "org.eclipse.ui.MessageConsole"; //$NON-NLS-1$
36      
37      /**
38       * The name of the font to use for the Console (value <code>"org.eclipse.ui.console.ConsoleFont"</code>).
39       * 
40       * @deprecated When a console is created, its font is set to the default text font as specified
41       * by <code>JFaceResources.TEXT_FONT</code>. Clients must provide their own infrastructure to
42       * manage console specific fonts. 
43       */ 
44      public static final String   CONSOLE_FONT= "org.eclipse.ui.console.ConsoleFont"; //$NON-NLS-1$
45      
46      /**
47       * Menu group identifier for the console view context menu and toolbar, for actions pertaining to
48       * launching (value <code>"launchGroup"</code>).
49       */
50      public static final String   LAUNCH_GROUP = "launchGroup"; //$NON-NLS-1$
51  
52      /**
53       * Menu group identifier for the console view context menu and toolbar, for actions pertaining to
54       * console output. (value<code>"outputGroup"</code>).
55       */
56      public static final String   OUTPUT_GROUP = "outputGroup"; //$NON-NLS-1$  
57          
58      /** 
59       * Console view image identifier.
60       */
61      public static final String   IMG_VIEW_CONSOLE= "IMG_VIEW_CONSOLE"; //$NON-NLS-1$
62      
63      /** 
64       * Clear action image identifier. 
65       */
66      public static final String   IMG_LCL_CLEAR= "IMG_LCL_CLEAR"; //$NON-NLS-1$
67          
68      /**
69       * Status code indicating an unexpected internal error.
70       */
71      public static final int INTERNAL_ERROR = 120;
72  
73      /**
74       * Console pattern match listeners extension point identifier
75       * (value <code>"consolePatternMatchListeners"</code>).
76       * 
77       * @since 3.1 
78       */
79      public static final String   EXTENSION_POINT_CONSOLE_PATTERN_MATCH_LISTENERS = "consolePatternMatchListeners"; //$NON-NLS-1$
80  
81      /**
82       * Console page participants extension point identifier
83       * (value <code>"consolePageParticipants"</code>).
84       * 
85       * @since 3.1
86       */
87      public static final String   EXTENSION_POINT_CONSOLE_PAGE_PARTICIPANTS = "consolePageParticipants"; //$NON-NLS-1$
88  
89      /**
90       * Console factories extension point identifier
91       * (value <code>"consoleFactories"</code>).
92       * 
93       * @since 3.1
94       */
95      public static final String   EXTENSION_POINT_CONSOLE_FACTORIES = "consoleFactories"; //$NON-NLS-1$
96      
97      /**
98       * Property constant indicating a console's font has changed.
99       *  
100      * @since 3.1
101      */
102     public static final String   P_FONT = ConsolePlugin.getUniqueIdentifier() + ".P_FONT"; //$NON-NLS-1$
103     
104     /**
105      * Property constant indicating that a font style has changed
106      * 
107      * @since 3.1
108      */
109     public static final String   P_FONT_STYLE = ConsolePlugin.getUniqueIdentifier() + ".P_FONT_STYLE"; //$NON-NLS-1$
110     
111     /**
112      * Property constant indicating the color of a stream has changed.
113      * 
114      *  @since 3.1
115      */
116     public static final String   P_STREAM_COLOR = ConsolePlugin.getUniqueIdentifier()  + ".P_STREAM_COLOR";    //$NON-NLS-1$
117         
118     /**
119      * Property constant indicating tab size has changed
120      * 
121      *  @since 3.1
122      */
123     public static final String   P_TAB_SIZE = ConsolePlugin.getUniqueIdentifier()  + ".P_TAB_SIZE";    //$NON-NLS-1$
124     
125     /**
126      * Property constant indicating the width of a fixed width console has changed.
127      * 
128      * @since 3.1
129      */
130     public static final String   P_CONSOLE_WIDTH = ConsolePlugin.getUniqueIdentifier() + ".P_CONSOLE_WIDTH"; //$NON-NLS-1$
131     
132     /**
133      * Property constant indicating that all streams connected to this console have been closed
134      * and that all queued output has been processed.
135      * 
136      * @since 3.1
137      */
138     public static final String   P_CONSOLE_OUTPUT_COMPLETE = ConsolePlugin.getUniqueIdentifier() + ".P_CONSOLE_STREAMS_CLOSED"; //$NON-NLS-1$
139     
140     /**
141      * Property constant indicating the background color of a console has changed.
142      * 
143      *  @since 3.3
144      */
145     public static final String   P_BACKGROUND_COLOR = ConsolePlugin.getUniqueIdentifier()  + ".P_BACKGROUND_COLOR";    //$NON-NLS-1$  
146 
147     /**
148      * The default tab size for text consoles.
149      * 
150      * @since 3.1
151      */
152     public static final int DEFAULT_TAB_SIZE = 8;
153 
154 }
155
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Free Books Free Magazines
Popular Tags