IResourceActionFilter


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   * Describes the public attributes for a resource and the acceptable values
15   * each may have.  
16   * <p>
17   * A popup menu extension may use these constants to describe its object target.  
18   * Each identifies an attribute name or possible value.  
19   * <p>
20   * Clients are not expected to implement this interface.
21   * </p>
22   *
23   * @see org.eclipse.ui.IActionFilter
24   */
25  public interface IResourceActionFilter extends IActionFilter {
26      /**
27       * An attribute indicating the file name (value <code>"name"</code>).  
28       * The attribute value in xml is unconstrained.  "*" may be used at the start or
29       * the end to represent "one or more characters".
30       */
31      public static final String   NAME = "name"; //$NON-NLS-1$
32  
33      /**
34       * An attribute indicating the file extension (value <code>"extension"</code>).
35       * The attribute value in xml is unconstrained.
36       */
37      public static final String   EXTENSION = "extension"; //$NON-NLS-1$
38  
39      /**
40       * An attribute indicating the file path (value <code>"path"</code>).
41       * The attribute value in xml is unconstrained.  "*" may be used at the start or
42       * the end to represent "one or more characters".
43       */
44      public static final String   PATH = "path"; //$NON-NLS-1$
45  
46      /**
47       * An attribute indicating whether the file is read only (value <code>"readOnly"</code>).
48       * The attribute value in xml must be one of <code>"true" or "false"</code>.
49       */
50      public static final String   READ_ONLY = "readOnly"; //$NON-NLS-1$
51  
52      /**
53       * An attribute indicating the project nature (value <code>"projectNature"</code>).
54       * The attribute value in xml is unconstrained.
55       */
56      public static final String   PROJECT_NATURE = "projectNature"; //$NON-NLS-1$
57  
58      /**
59       * An attribute indicating a persistent property on the selected resource 
60       * (value <code>"persistentProperty"</code>).
61       * If the value is a simple string, then this simply tests for existence of the property on the resource.
62       * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
63       * with the specified name and tests it for equality with the specified value.
64       */
65      public static final String   PERSISTENT_PROPERTY = "persistentProperty"; //$NON-NLS-1$
66  
67      /**
68       * An attribute indicating a persistent property on the selected resource's project. 
69       * (value <code>"projectPersistentProperty"</code>).
70       * If the value is a simple string, then this simply tests for existence of the property on the resource.
71       * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
72       * with the specified name and tests it for equality with the specified value.
73       */
74      public static final String   PROJECT_PERSISTENT_PROPERTY = "projectPersistentProperty"; //$NON-NLS-1$
75  
76      /**
77       * An attribute indicating a session property on the selected resource 
78       * (value <code>"sessionProperty"</code>).
79       * If the value is a simple string, then this simply tests for existence of the property on the resource.
80       * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
81       * with the specified name and tests it for equality with the specified value.
82       */
83      public static final String   SESSION_PROPERTY = "sessionProperty"; //$NON-NLS-1$
84  
85      /**
86       * An attribute indicating a session property on the selected resource's project. 
87       * (value <code>"projectSessionProperty"</code>).
88       * If the value is a simple string, then this simply tests for existence of the property on the resource.
89       * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
90       * with the specified name and tests it for equality with the specified value.
91       */
92      public static final String   PROJECT_SESSION_PROPERTY = "projectSessionProperty"; //$NON-NLS-1$
93  
94      /**
95       * An attribute indicating that this is an xml file
96       * and we should ensure that the first tag (or top-level
97       * tag) has this name.
98       * @since 3.0
99       * @deprecated Please use content types instead.
100      */
101     public static final String   XML_FIRST_TAG = "xmlFirstTag"; //$NON-NLS-1$
102 
103     /**
104      * An attribute indicating that this is an xml file and we should ensure that the DTD
105      * definition in this xml file is the value supplied with this attribute.
106      * @since 3.0
107      * @deprecated Please use content types instead.
108      */
109     public static final String   XML_DTD_NAME = "xmlDTDName"; //$NON-NLS-1$
110 
111     /**
112      * An attribute indicating that this is a file, and we are looking to verify
113      * that the file matches the content type matching the given identifier.
114      * The identifier is provided in the value.
115      * @since 3.0
116      */
117     public static final String   CONTENT_TYPE_ID = "contentTypeId"; //$NON-NLS-1$
118 }
119
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags