FormattingContextProperties


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  
12  package org.eclipse.jface.text.formatter;
13  
14  /**
15   * Keys used by <code>IFormattingContext</code> objects to register specific
16   * properties needed during the formatting process of a content formatter
17   * implementing <code>IContentFormatterExtension</code>.
18   *
19   * @see IFormattingContext
20   * @see IFormattingStrategyExtension
21   * @see IContentFormatterExtension
22   * @since 3.0
23   */
24  public class FormattingContextProperties {
25  
26      /**
27       * Property key of the document property. The property must implement
28       * <code>java.lang#Boolean</code>. If set to <code>true</code> the whole
29       * document is formatted.
30       * <p>
31       * Value: <code>"formatting.context.document"</code>
32       */
33      public static final String   CONTEXT_DOCUMENT= "formatting.context.document"; //$NON-NLS-1$
34  
35      /**
36       * Property key of the partition property. The property must implement
37       * <code>org.eclipse.jface.text#TypedPosition</code>. The partition
38       * a context based formatting strategy should format.
39       * <p>
40       * Value: <code>"formatting.context.partition"</code>
41       */
42      public static final String   CONTEXT_PARTITION= "formatting.context.partition"; //$NON-NLS-1$
43  
44      /**
45       * Property key of the preferences property. The property must implement
46       * <code>java.util#Map</code>. The formatting preferences mapping preference
47       * keys to values.
48       * <p>
49       * Value: <code>"formatting.context.preferences"</code>
50       */
51      public static final String   CONTEXT_PREFERENCES= "formatting.context.preferences"; //$NON-NLS-1$
52  
53      /**
54       * Property key of the region property. The property must implement <code>org.eclipse.jface.text#IRegion</code>.
55       * The region to format. If set, {@link FormattingContextProperties#CONTEXT_DOCUMENT} should be <code>false</code>
56       * for this to take effect.
57       * <p>
58       * Value: <code>"formatting.context.region"</code>
59       */
60      public static final String   CONTEXT_REGION= "formatting.context.region"; //$NON-NLS-1$
61  
62      /**
63       * Property key of the medium property. The property must implement <code>org.eclipse.jface.text#IDocument</code>.
64       * The document to format.
65       * <p>
66       * Value: <code>"formatting.context.medium"</code>
67       */
68      public static final String   CONTEXT_MEDIUM= "formatting.context.medium"; //$NON-NLS-1$
69  
70      /**
71       * Ensure that this class cannot be instantiated.
72       */
73      private FormattingContextProperties() {
74      }
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags