KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > IMarkerActionFilter


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 package org.eclipse.ui;
12
13
14 /**
15  * Describes the public attributes for a marker and the acceptable values
16  * each may have.
17  * <p>
18  * A popup menu extension may use these constants to describe its object target.
19  * Each identifies an attribute name or possible value.
20  * <p>
21  * Clients are not expected to implement this interface.
22  * </p>
23  *
24  * @see IActionFilter
25  */
26 public interface IMarkerActionFilter extends IActionFilter {
27     /**
28      * An attribute indicating the marker type (value <code>"type"</code>).
29      * The attribute value in xml should match one of the marker types defined in
30      * the workbench's marker extension point. Common examples are
31      * <code>IMarker.TASK, IMarker.BOOKMARK, and IMarker.MARKER</code>.
32      */
33     public static final String JavaDoc TYPE = "type"; //$NON-NLS-1$
34
35     /**
36      * An attribute indicating the marker super type (value <code>"superType"</code>).
37      * The attribute value in xml should match one of the marker types defined in
38      * the workbench's marker extension point. Common examples are
39      * <code>IMarker.TASK, IMarker.BOOKMARK, and IMarker.MARKER</code>.
40      */
41     public static final String JavaDoc SUPER_TYPE = "superType"; //$NON-NLS-1$
42
43     /**
44      * An attribute indicating the marker priority (value <code>"priority"</code>).
45      * The attribute value in xml must be one of <code>IMarker.PRIORITY_LOW,
46      * IMarker.PRIORITY_NORMAL, or IMarker.PRIORITY_HIGH</code>
47      */
48     public static final String JavaDoc PRIORITY = "priority"; //$NON-NLS-1$
49
50     /**
51      * An attribute indicating the marker severity (value <code>"severity"</code>).
52      * The attribute value in xml in xml must be one of <code>IMarker.SEVERITY_ERROR,
53      * IMarker.SEVERITY_WARNING, or IMarker.SEVERITY_INFO</code>
54      */
55     public static final String JavaDoc SEVERITY = "severity"; //$NON-NLS-1$
56
57     /**
58      * An attribute indicating whether the marker is considered done (value
59      * <code>"done"</code>).
60      * The attribute value in xml must be one of <code>"true" or "false"</code>.
61      */
62     public static final String JavaDoc DONE = "done"; //$NON-NLS-1$
63
64     /**
65      * An attribute indicating the marker message (value <code>"message"</code>).
66      * The attribute value in xml is unconstrained. "*" may be used at the start or
67      * the end to represent "one or more characters".
68      */
69     public static final String JavaDoc MESSAGE = "message"; //$NON-NLS-1$
70
71     /**
72      * An attribute indicating the type of resource associated with the marker
73      * (value <code>"resourceType"</code>). The attribute value in xml must be
74      * one of <code>IResource.FILE, IResource.PROJECT, IResource.FOLDER,
75      * or IResource.ROOT</code>.
76      */
77     public static final String JavaDoc RESOURCE_TYPE = "resourceType"; //$NON-NLS-1$
78
79 }
80
Popular Tags