Mercurial > projects > dwt-addons
diff dwtx/jface/text/formatter/FormattingContextProperties.d @ 129:eb30df5ca28b
Added JFace Text sources
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 23 Aug 2008 19:10:48 +0200 |
parents | |
children | c4fb132a086c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/text/formatter/FormattingContextProperties.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,79 @@ +/******************************************************************************* + * 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 + * Port to the D programming language: + * Frank Benoit <benoit@tionex.de> + *******************************************************************************/ + +module dwtx.jface.text.formatter.FormattingContextProperties; + +import dwt.dwthelper.utils; + +/** + * Keys used by <code>IFormattingContext</code> objects to register specific + * properties needed during the formatting process of a content formatter + * implementing <code>IContentFormatterExtension</code>. + * + * @see IFormattingContext + * @see IFormattingStrategyExtension + * @see IContentFormatterExtension + * @since 3.0 + */ +public class FormattingContextProperties { + + /** + * Property key of the document property. The property must implement + * <code>java.lang#Boolean</code>. If set to <code>true</code> the whole + * document is formatted. + * <p> + * Value: <code>"formatting.context.document"</code> + */ + public static final String CONTEXT_DOCUMENT= "formatting.context.document"; //$NON-NLS-1$ + + /** + * Property key of the partition property. The property must implement + * <code>dwtx.jface.text#TypedPosition</code>. The partition + * a context based formatting strategy should format. + * <p> + * Value: <code>"formatting.context.partition"</code> + */ + public static final String CONTEXT_PARTITION= "formatting.context.partition"; //$NON-NLS-1$ + + /** + * Property key of the preferences property. The property must implement + * <code>java.util#Map</code>. The formatting preferences mapping preference + * keys to values. + * <p> + * Value: <code>"formatting.context.preferences"</code> + */ + public static final String CONTEXT_PREFERENCES= "formatting.context.preferences"; //$NON-NLS-1$ + + /** + * Property key of the region property. The property must implement <code>dwtx.jface.text#IRegion</code>. + * The region to format. If set, {@link FormattingContextProperties#CONTEXT_DOCUMENT} should be <code>false</code> + * for this to take effect. + * <p> + * Value: <code>"formatting.context.region"</code> + */ + public static final String CONTEXT_REGION= "formatting.context.region"; //$NON-NLS-1$ + + /** + * Property key of the medium property. The property must implement <code>dwtx.jface.text#IDocument</code>. + * The document to format. + * <p> + * Value: <code>"formatting.context.medium"</code> + */ + public static final String CONTEXT_MEDIUM= "formatting.context.medium"; //$NON-NLS-1$ + + /** + * Ensure that this class cannot be instantiated. + */ + private FormattingContextProperties() { + } +}