org.eclipse.jface.text.formatter.FormattingContextProperties Maven / Gradle / Ivy
Show all versions of spotless-ext-greclipse Show documentation
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.formatter;
/**
* Keys used by IFormattingContext objects to register specific
* properties needed during the formatting process of a content formatter
* implementing IContentFormatterExtension.
*
* @see IFormattingContext
* @see IFormattingStrategyExtension
* @see IContentFormatterExtension
* @since 3.0
*/
public class FormattingContextProperties {
/**
* Property key of the document property. The property must implement
* java.lang#Boolean. If set to true the whole
* document is formatted.
*
* Value: "formatting.context.document"
*/
public static final String CONTEXT_DOCUMENT= "formatting.context.document"; //$NON-NLS-1$
/**
* Property key of the partition property. The property must implement
* org.eclipse.jface.text#TypedPosition. The partition
* a context based formatting strategy should format.
*
* Value: "formatting.context.partition"
*/
public static final String CONTEXT_PARTITION= "formatting.context.partition"; //$NON-NLS-1$
/**
* Property key of the preferences property. The property must implement
* java.util#Map. The formatting preferences mapping preference
* keys to values.
*
* Value: "formatting.context.preferences"
*/
public static final String CONTEXT_PREFERENCES= "formatting.context.preferences"; //$NON-NLS-1$
/**
* Property key of the region property. The property must implement org.eclipse.jface.text#IRegion.
* The region to format. If set, {@link FormattingContextProperties#CONTEXT_DOCUMENT} should be false
* for this to take effect.
*
* Value: "formatting.context.region"
*/
public static final String CONTEXT_REGION= "formatting.context.region"; //$NON-NLS-1$
/**
* Property key of the medium property. The property must implement org.eclipse.jface.text#IDocument.
* The document to format.
*
* Value: "formatting.context.medium"
*/
public static final String CONTEXT_MEDIUM= "formatting.context.medium"; //$NON-NLS-1$
/**
* Ensure that this class cannot be instantiated.
*/
private FormattingContextProperties() {
}
}