org.eclipse.osbp.ecview.extension.api/src/org/eclipse/osbp/ecview/extension/api/ILayoutingStrategy.java - osbp/org.eclipse.osbp.ecview.extension.api - Git at Google

 /**
  *
  *  Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
  *
  *  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:
  * 	   Florian Pirchner - Initial implementation
  *
  */
 package org.eclipse.osbp.ecview.extension.api;

 import org.eclipse.osbp.ecview.extension.model.YLayoutingInfo;

 /**
  * Is used to layout the given model properly.
  */
 public interface ILayoutingStrategy {

 	/** The Constant TAG__TEXT. */
 	public static final String TAG__TEXT = "text";

 	/** The Constant TAG__SUGGEST_TEXT. */
 	public static final String TAG__SUGGEST_TEXT = "suggestText";

 	/** The Constant TAG__TEXTAREA. */
 	public static final String TAG__TEXTAREA = "textarea";

 	/** The Constant TAG__NUMBER. */
 	public static final String TAG__NUMBER = "number";

 	// autobinded
 	public static final String TAG__AUTOBINDED = "autobinded";


 	/**
 	 * Attributes tagged with this property are being presented by a
 	 * RichTextField using value-Binding (String).
 	 */
 	public final static String TAG__RICH_TEXT__STRING = "richText__String";

 	/**
 	 * Attributes tagged with this property are being presented by a
 	 * MaskedTextField.
 	 */
 	public final static String TAG__MASKED_TEXT_FIELD = "maskedTextField";

 	/**
 	 * Attributes tagged with this property are being presented by a
 	 * MaskedDecimalField.
 	 */
 	public final static String TAG__MASKED_DECIMAL_FIELD = "maskedDecimalField";

 	/**
 	 * Attributes tagged with this property are being presented by a
 	 * RichTextField using blob-Value-Binding (byte[]).
 	 */
 	public final static String TAG__RICH_TEXT__BLOB = "richText__Blob";

 	/**
 	 * The property is visible on the kanban card.
 	 */
 	public final static String TAG__ON_KANBAN_CARD = "onKanbanCard";

 	/**
 	 * Attributes tagged with this property are being presented by a
 	 * PasswordField using value-Binding (String).
 	 */
 	public final static String TAG__PASSWORD = "password";

 	/** The Constant TAG__DECIMAL. */
 	public static final String TAG__DECIMAL = "decimal";

 	/** The Constant TAG__BOOLEAN. */
 	public static final String TAG__BOOLEAN = "boolean";

 	/** The Constant TAG__DATE. */
 	public static final String TAG__DATE = "date";

 	/** The Constant TAG__ENUM_OPTIONS. */
 	public static final String TAG__ENUM_OPTIONS = "enumOptions";

 	/** The Constant TAG_ENUM_COMBO. */
 	public final static String TAG__ENUM_COMBO = "enumCombo";

 	/** The Constant TAG__ORGANIZATION_COMBO. */
 	public final static String TAG__ORGANIZATION_COMBO = "organizationCombo";

 	/** The Constant TAG__PERSPECTIVE_COMBO. */
 	public final static String TAG__PERSPECTIVE_COMBO = "perpectiveCombo";

 	/** The Constant TAG__THEME_COMBO. */
 	public final static String TAG__THEME_COMBO = "themeCombo";

 	/** The Constant TAG__I18N_COMBO. */
 	public final static String TAG__I18N_COMBO = "i18nCombo";

 	/** The Constant TAG__PRINTSERVICE_COMBO. */
 	public final static String TAG__PRINTSERVICE_COMBO = "printserviceCombo";

 	/** The Constant TAG__BLOB. */
 	public static final String TAG__BLOB = "blob";

 	/** The Constant TAG__BEAN_REFERENCE. */
 	public static final String TAG__BEAN_REFERENCE = "beanReference";

 	/** The Constant TAG__GRID. */
 	public static final String TAG__GRID = "grid";

 	/** The Constant TAG__TABLE. */
 	public static final String TAG__TABLE = "table";

 	/** The Constant TAG__CONSTRAINT. */
 	public static final String TAG__CONSTRAINT = "constraint";

 	/** The Constant TAG__UNIQUE. */
 	public static final String TAG__UNIQUE = "unique";

 	/**
 	 * The Constant TAG__DTO. Suspects of this type define suspects for a whole
 	 * dto.
 	 */
 	public static final String TAG__DTO = "dto";

 	/**
 	 * The Constant TAG__SUBTYPE. <br>
 	 * Suspects and beanslots of this type are DTO Suspects for sub classes of
 	 * the main dto. Their visiblity needs to be controlled.
 	 */
 	public static final String TAG__SUBTYPE = "dto_subtype";

 	/**
 	 * The Constant TAG__SUBTYPES_ROOT. <br>
 	 * Suspects of this type contain further compound suspects. One for each
 	 * direct subclass.
 	 */
 	public static final String TAG__SUBTYPES_ROOT = "dto_subtypes_root";

 	/**
 	 * Model elements tagged with this tag need to be removed / disposed before
 	 * next {@link #layout(YLayoutingInfo)}.
 	 */
 	public static final String TAG__TO_BE_CLEANED = "strategylayout__toBeCleaned";

 	/**
 	 * The Constant PROPERTY__SUBTYPE. The autowirehelper passes the classname
 	 * of the sub type in this property.
 	 */
 	public static final String PROPERTY__SUBTYPE_CLASS = "dto_subtype_className";

 	/** The Constant TAG__IMAGE_PICKER. */
 	public static final String TAG__IMAGE_PICKER = "imagePicker";
 	// public static final String TAG__CATEGORY_1 = "category1";
 	// public static final String TAG__CATEGORY_2 = "category2";
 	/** The Constant PROPERTY_TEXTAREA. */
 	// Constants
 	public final static String PROPERTY_TEXTAREA = "textarea";

 	/** The Constant PROPERTY_BLOB. */
 	public final static String PROPERTY_BLOB = "blob";

 	/** The Constant PROPERTY_BLOB_FIRMLY_LINKED. */
 	public final static String PROPERTY_BLOB_FIRMLY_LINKED = "blobfirmlylinked";

 	/** The Constant PROPERTY_BLOB_UNIQUE_NAMED. */
 	public final static String PROPERTY_BLOB_UNIQUE_NAMED = "blobuniquenamed";

 	/**
 	 * Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
 	 * the field from data model should be presented by a RichTextArea. <br>
 	 * Eg: <code>key="type" value="richTextArea"</code>
 	 * <p>
 	 * Whether value-binding (String) or blob-Value-Binding (byte[]) is used,
 	 * depends on the underlying data model. String-binding for String and
 	 * Blob-Binding for byte[].
 	 */
 	public final static String PROPERTY_RICH_TEXT = "richTextArea";

 	/**
 	 * Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
 	 * the field from data model should be presented by a MaskedTextField. <br>
 	 * Eg: <code>key="type" value="maskedText"</code>
 	 * <p>
 	 * This type need to be used together with the key "mask". Eg:
 	 * <code>var MaskedText text properties (key="mask" value="UUU-###")</code>
 	 * <p>
 	 */
 	public final static String PROPERTY_MASKED_TEXT = "maskedText";

 	/**
 	 * Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
 	 * the field from data model should be presented by a MaskedDecimalField.
 	 * <br>
 	 * Eg: <code>key="type" value="maskedDecimal"</code>
 	 * <p>
 	 * This type need to be used together with the key "mask". Eg:
 	 * <code>var MaskedDecimal text properties (key="mask" value="#,#00.000")</code>
 	 * <p>
 	 */
 	public final static String PROPERTY_MASKED_DECIMAL = "maskedDecimal";

 	/**
 	 * See {@link #PROPERTY_MASKED_TEXT}
 	 */
 	public final static String PROPERTY_MASK = "mask";

 	/**
 	 * Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
 	 * the field from data model should be presented by a PasswordField. <br>
 	 * Eg: <code>key="type" value="Password"</code>
 	 */
 	public final static String PROPERTY_PASSWORD = "password";

 	/**
 	 * The key value for properties.<br>
 	 * Eg: <code>key="type" value="RichTextArea"</code> creates a RichTextArea
 	 * for the given data model attribute.
 	 */
 	public final static String PROPERTY_KEY__FIELD_TYPE = "type";

 	/** The Constant PROPERTY_GRID. */
 	public final static String PROPERTY_OPTION_GROUP = "optionGroup";

 	/** The Constant PROPERTY_GRID. */
 	public final static String PROPERTY_GRID = "grid";

 	/** The Constant PROPERTY_TABLE. */
 	public final static String PROPERTY_TABLE = "table";

 	/** The Constant PROPERTY_DECIMALFORMAT. */
 	public final static String PROPERTY_DECIMALFORMAT = "decimalformat";

 	/** The Constant PROPERTY_CLASS. */
 	public final static String PROPERTY_CLASS = "class";

 	/** The Constant PROPERTY_NAME. */
 	public final static String PROPERTY_NAME = "name";

 	/**
 	 * The depth of filters used for BeanReferenceFields
 	 */
 	public static final String PROPERTY__FILTER_DEPTH = "filterDepth";

 	/**
 	 * Defines the caption property name to be used in combo boxes, suggest text
 	 * fields,...
 	 */
 	public static final String PROPERTY__ITEM_CAPTION = "itemCaptionProperty";

 	/**
 	 * Defines the description property name to be used in combo boxes, suggest
 	 * text fields,...
 	 */
 	public static final String PROPERTY__ITEM_DESCRIPTION = "itemDescriptionProperty";

 	/**
 	 * Defines the filter property name to be used in suggest text fields,...
 	 */
 	public static final String PROPERTY__ITEM_FILTER = "itemFilterProperty";

 	/**
 	 * Defines the uuid property name to be used in suggest text fields,...
 	 */
 	public static final String PROPERTY__ITEM_UUID = "itemUUIDProperty";

 	/** The Constant PROPERTY_ORGANIZATION. */
 	public final static String PROPERTY_ORGANIZATION = "organization";

 	/** The Constant PROPERTY_PERSPECTIVE. */
 	public final static String PROPERTY_PERSPECTIVE = "perspective";

 	/** The Constant PROPERTY_THEME. */
 	public final static String PROPERTY_THEME = "theme";

 	/** The Constant PROPERTY_THEME. */
 	public final static String PROPERTY_I18N = "i18n";

 	/** The Constant PROPERTY_PRINTSERVICE. */
 	public final static String PROPERTY_PRINTSERVICE = "printservice";

 	/** The Constant PROPERTY_SUGGESTTEXT. */
 	public final static String PROPERTY_SUGGESTTEXT = "suggestion";

 	/**
 	 * Does the layouting for model.
 	 *
 	 * @param layoutingInfo
 	 *            the layouting info
 	 */
 	void layout(YLayoutingInfo layoutingInfo);

 }
	/**
	*
	* Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
	*
	* 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:
	* Florian Pirchner - Initial implementation
	*
	*/
	package org.eclipse.osbp.ecview.extension.api;

	import org.eclipse.osbp.ecview.extension.model.YLayoutingInfo;

	/**
	* Is used to layout the given model properly.
	*/
	public interface ILayoutingStrategy {

	/** The Constant TAG__TEXT. */
	public static final String TAG__TEXT = "text";

	/** The Constant TAG__SUGGEST_TEXT. */
	public static final String TAG__SUGGEST_TEXT = "suggestText";

	/** The Constant TAG__TEXTAREA. */
	public static final String TAG__TEXTAREA = "textarea";

	/** The Constant TAG__NUMBER. */
	public static final String TAG__NUMBER = "number";

	// autobinded
	public static final String TAG__AUTOBINDED = "autobinded";


	/**
	* Attributes tagged with this property are being presented by a
	* RichTextField using value-Binding (String).
	*/
	public final static String TAG__RICH_TEXT__STRING = "richText__String";

	/**
	* Attributes tagged with this property are being presented by a
	* MaskedTextField.
	*/
	public final static String TAG__MASKED_TEXT_FIELD = "maskedTextField";

	/**
	* Attributes tagged with this property are being presented by a
	* MaskedDecimalField.
	*/
	public final static String TAG__MASKED_DECIMAL_FIELD = "maskedDecimalField";

	/**
	* Attributes tagged with this property are being presented by a
	* RichTextField using blob-Value-Binding (byte[]).
	*/
	public final static String TAG__RICH_TEXT__BLOB = "richText__Blob";

	/**
	* The property is visible on the kanban card.
	*/
	public final static String TAG__ON_KANBAN_CARD = "onKanbanCard";

	/**
	* Attributes tagged with this property are being presented by a
	* PasswordField using value-Binding (String).
	*/
	public final static String TAG__PASSWORD = "password";

	/** The Constant TAG__DECIMAL. */
	public static final String TAG__DECIMAL = "decimal";

	/** The Constant TAG__BOOLEAN. */
	public static final String TAG__BOOLEAN = "boolean";

	/** The Constant TAG__DATE. */
	public static final String TAG__DATE = "date";

	/** The Constant TAG__ENUM_OPTIONS. */
	public static final String TAG__ENUM_OPTIONS = "enumOptions";

	/** The Constant TAG_ENUM_COMBO. */
	public final static String TAG__ENUM_COMBO = "enumCombo";

	/** The Constant TAG__ORGANIZATION_COMBO. */
	public final static String TAG__ORGANIZATION_COMBO = "organizationCombo";

	/** The Constant TAG__PERSPECTIVE_COMBO. */
	public final static String TAG__PERSPECTIVE_COMBO = "perpectiveCombo";

	/** The Constant TAG__THEME_COMBO. */
	public final static String TAG__THEME_COMBO = "themeCombo";

	/** The Constant TAG__I18N_COMBO. */
	public final static String TAG__I18N_COMBO = "i18nCombo";

	/** The Constant TAG__PRINTSERVICE_COMBO. */
	public final static String TAG__PRINTSERVICE_COMBO = "printserviceCombo";

	/** The Constant TAG__BLOB. */
	public static final String TAG__BLOB = "blob";

	/** The Constant TAG__BEAN_REFERENCE. */
	public static final String TAG__BEAN_REFERENCE = "beanReference";

	/** The Constant TAG__GRID. */
	public static final String TAG__GRID = "grid";

	/** The Constant TAG__TABLE. */
	public static final String TAG__TABLE = "table";

	/** The Constant TAG__CONSTRAINT. */
	public static final String TAG__CONSTRAINT = "constraint";

	/** The Constant TAG__UNIQUE. */
	public static final String TAG__UNIQUE = "unique";

	/**
	* The Constant TAG__DTO. Suspects of this type define suspects for a whole
	* dto.
	*/
	public static final String TAG__DTO = "dto";

	/**
	* The Constant TAG__SUBTYPE. <br>
	* Suspects and beanslots of this type are DTO Suspects for sub classes of
	* the main dto. Their visiblity needs to be controlled.
	*/
	public static final String TAG__SUBTYPE = "dto_subtype";

	/**
	* The Constant TAG__SUBTYPES_ROOT. <br>
	* Suspects of this type contain further compound suspects. One for each
	* direct subclass.
	*/
	public static final String TAG__SUBTYPES_ROOT = "dto_subtypes_root";

	/**
	* Model elements tagged with this tag need to be removed / disposed before
	* next {@link #layout(YLayoutingInfo)}.
	*/
	public static final String TAG__TO_BE_CLEANED = "strategylayout__toBeCleaned";

	/**
	* The Constant PROPERTY__SUBTYPE. The autowirehelper passes the classname
	* of the sub type in this property.
	*/
	public static final String PROPERTY__SUBTYPE_CLASS = "dto_subtype_className";

	/** The Constant TAG__IMAGE_PICKER. */
	public static final String TAG__IMAGE_PICKER = "imagePicker";
	// public static final String TAG__CATEGORY_1 = "category1";
	// public static final String TAG__CATEGORY_2 = "category2";
	/** The Constant PROPERTY_TEXTAREA. */
	// Constants
	public final static String PROPERTY_TEXTAREA = "textarea";

	/** The Constant PROPERTY_BLOB. */
	public final static String PROPERTY_BLOB = "blob";

	/** The Constant PROPERTY_BLOB_FIRMLY_LINKED. */
	public final static String PROPERTY_BLOB_FIRMLY_LINKED = "blobfirmlylinked";

	/** The Constant PROPERTY_BLOB_UNIQUE_NAMED. */
	public final static String PROPERTY_BLOB_UNIQUE_NAMED = "blobuniquenamed";

	/**
	* Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
	* the field from data model should be presented by a RichTextArea. <br>
	* Eg: <code>key="type" value="richTextArea"</code>
	* <p>
	* Whether value-binding (String) or blob-Value-Binding (byte[]) is used,
	* depends on the underlying data model. String-binding for String and
	* Blob-Binding for byte[].
	*/
	public final static String PROPERTY_RICH_TEXT = "richTextArea";

	/**
	* Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
	* the field from data model should be presented by a MaskedTextField. <br>
	* Eg: <code>key="type" value="maskedText"</code>
	* <p>
	* This type need to be used together with the key "mask". Eg:
	* <code>var MaskedText text properties (key="mask" value="UUU-###")</code>
	* <p>
	*/
	public final static String PROPERTY_MASKED_TEXT = "maskedText";

	/**
	* Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
	* the field from data model should be presented by a MaskedDecimalField.
	* <br>
	* Eg: <code>key="type" value="maskedDecimal"</code>
	* <p>
	* This type need to be used together with the key "mask". Eg:
	* <code>var MaskedDecimal text properties (key="mask" value="#,#00.000")</code>
	* <p>
	*/
	public final static String PROPERTY_MASKED_DECIMAL = "maskedDecimal";

	/**
	* See {@link #PROPERTY_MASKED_TEXT}
	*/
	public final static String PROPERTY_MASK = "mask";

	/**
	* Together with the key {@link #PROPERTY_KEY__FIELD_TYPE} it indicates that
	* the field from data model should be presented by a PasswordField. <br>
	* Eg: <code>key="type" value="Password"</code>
	*/
	public final static String PROPERTY_PASSWORD = "password";

	/**
	* The key value for properties.<br>
	* Eg: <code>key="type" value="RichTextArea"</code> creates a RichTextArea
	* for the given data model attribute.
	*/
	public final static String PROPERTY_KEY__FIELD_TYPE = "type";

	/** The Constant PROPERTY_GRID. */
	public final static String PROPERTY_OPTION_GROUP = "optionGroup";

	/** The Constant PROPERTY_GRID. */
	public final static String PROPERTY_GRID = "grid";

	/** The Constant PROPERTY_TABLE. */
	public final static String PROPERTY_TABLE = "table";

	/** The Constant PROPERTY_DECIMALFORMAT. */
	public final static String PROPERTY_DECIMALFORMAT = "decimalformat";

	/** The Constant PROPERTY_CLASS. */
	public final static String PROPERTY_CLASS = "class";

	/** The Constant PROPERTY_NAME. */
	public final static String PROPERTY_NAME = "name";

	/**
	* The depth of filters used for BeanReferenceFields
	*/
	public static final String PROPERTY__FILTER_DEPTH = "filterDepth";

	/**
	* Defines the caption property name to be used in combo boxes, suggest text
	* fields,...
	*/
	public static final String PROPERTY__ITEM_CAPTION = "itemCaptionProperty";

	/**
	* Defines the description property name to be used in combo boxes, suggest
	* text fields,...
	*/
	public static final String PROPERTY__ITEM_DESCRIPTION = "itemDescriptionProperty";

	/**
	* Defines the filter property name to be used in suggest text fields,...
	*/
	public static final String PROPERTY__ITEM_FILTER = "itemFilterProperty";

	/**
	* Defines the uuid property name to be used in suggest text fields,...
	*/
	public static final String PROPERTY__ITEM_UUID = "itemUUIDProperty";

	/** The Constant PROPERTY_ORGANIZATION. */
	public final static String PROPERTY_ORGANIZATION = "organization";

	/** The Constant PROPERTY_PERSPECTIVE. */
	public final static String PROPERTY_PERSPECTIVE = "perspective";

	/** The Constant PROPERTY_THEME. */
	public final static String PROPERTY_THEME = "theme";

	/** The Constant PROPERTY_THEME. */
	public final static String PROPERTY_I18N = "i18n";

	/** The Constant PROPERTY_PRINTSERVICE. */
	public final static String PROPERTY_PRINTSERVICE = "printservice";

	/** The Constant PROPERTY_SUGGESTTEXT. */
	public final static String PROPERTY_SUGGESTTEXT = "suggestion";

	/**
	* Does the layouting for model.
	*
	* @param layoutingInfo
	* the layouting info
	*/
	void layout(YLayoutingInfo layoutingInfo);

	}