Package org.eclipse.jface.text.formatter

Class FormattingContextProperties

java.lang.Object

org.eclipse.jface.text.formatter.FormattingContextProperties

public class FormattingContextProperties
extends java.lang.Object

Keys used by IFormattingContext objects to register specific properties needed during the formatting process of a content formatter implementing IContentFormatterExtension.

Since:

3.0

See Also:

IFormattingContext, IFormattingStrategyExtension, IContentFormatterExtension

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONTEXT_DOCUMENT	Property key of the document property.
static java.lang.String	CONTEXT_MEDIUM	Property key of the medium property.
static java.lang.String	CONTEXT_PARTITION	Property key of the partition property.
static java.lang.String	CONTEXT_PREFERENCES	Property key of the preferences property.
static java.lang.String	CONTEXT_REGION	Property key of the region property.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_DOCUMENT

public static final java.lang.String CONTEXT_DOCUMENT

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"

See Also:

Constant Field Values

CONTEXT_PARTITION

public static final java.lang.String CONTEXT_PARTITION

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"

See Also:

Constant Field Values

CONTEXT_PREFERENCES

public static final java.lang.String CONTEXT_PREFERENCES

Property key of the preferences property. The property value must implement java.util.Map<String, String>. The formatting preferences mapping preference keys to values.

Value: "formatting.context.preferences"

See Also:

Constant Field Values

CONTEXT_REGION

public static final java.lang.String CONTEXT_REGION

Property key of the region property. The property must implement org.eclipse.jface.text#IRegion. The region to format. If set, CONTEXT_DOCUMENT should be false for this to take effect.

Value: "formatting.context.region"

See Also:

Constant Field Values

CONTEXT_MEDIUM

public static final java.lang.String CONTEXT_MEDIUM

Property key of the medium property. The property must implement org.eclipse.jface.text#IDocument. The document to format.

Value: "formatting.context.medium"

See Also:

Constant Field Values