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