| /** |
| * Copyright (c) 2015, 2018 Obeo. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0 |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: Obeo - initial API and implementation |
| */ |
| package org.eclipse.eef; |
| |
| import org.eclipse.emf.common.util.EList; |
| import org.eclipse.emf.ecore.EObject; |
| |
| /** |
| * <!-- begin-user-doc --> A representation of the model object '<em><b>EEF Page Description</b></em>'. <!-- |
| * end-user-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getLabelExpression <em>Label Expression</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getDomainClass <em>Domain Class</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getSemanticCandidateExpression <em>Semantic Candidate |
| * Expression</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getPreconditionExpression <em>Precondition Expression</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getGroups <em>Groups</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getSemanticValidationRules <em>Semantic Validation Rules</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#isIndented <em>Indented</em>}</li> |
| * <li>{@link org.eclipse.eef.EEFPageDescription#getActions <em>Actions</em>}</li> |
| * </ul> |
| * |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription() |
| * @model |
| * @generated |
| */ |
| public interface EEFPageDescription extends EObject { |
| /** |
| * Returns the value of the '<em><b>Identifier</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * <!-- begin-model-doc --> Used to identify a specific Page instance. <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Identifier</em>' attribute. |
| * @see #setIdentifier(String) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_Identifier() |
| * @model |
| * @generated |
| */ |
| String getIdentifier(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#getIdentifier <em>Identifier</em>}' attribute. |
| * <!-- begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Identifier</em>' attribute. |
| * @see #getIdentifier() |
| * @generated |
| */ |
| void setIdentifier(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Label Expression</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc |
| * --> <!-- begin-model-doc --> The label of the Page visible by the end-users. <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Label Expression</em>' attribute. |
| * @see #setLabelExpression(String) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_LabelExpression() |
| * @model |
| * @generated |
| */ |
| String getLabelExpression(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#getLabelExpression <em>Label Expression</em>}' |
| * attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Label Expression</em>' attribute. |
| * @see #getLabelExpression() |
| * @generated |
| */ |
| void setLabelExpression(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Domain Class</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * <!-- begin-model-doc --> The class of the EObject used as "self" in the page <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Domain Class</em>' attribute. |
| * @see #setDomainClass(String) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_DomainClass() |
| * @model |
| * @generated |
| */ |
| String getDomainClass(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#getDomainClass <em>Domain Class</em>}' |
| * attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Domain Class</em>' attribute. |
| * @see #getDomainClass() |
| * @generated |
| */ |
| void setDomainClass(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Semantic Candidate Expression</b></em>' attribute. The default value is |
| * <code>""</code>. <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> The elements that are |
| * represented. If not specified, the EEF runtime reuses the context of the View for the Page. <!-- end-model-doc |
| * --> |
| * |
| * @return the value of the '<em>Semantic Candidate Expression</em>' attribute. |
| * @see #setSemanticCandidateExpression(String) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_SemanticCandidateExpression() |
| * @model default="" |
| * @generated |
| */ |
| String getSemanticCandidateExpression(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#getSemanticCandidateExpression <em>Semantic |
| * Candidate Expression</em>}' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Semantic Candidate Expression</em>' attribute. |
| * @see #getSemanticCandidateExpression() |
| * @generated |
| */ |
| void setSemanticCandidateExpression(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Precondition Expression</b></em>' attribute. <!-- begin-user-doc --> <!-- |
| * end-user-doc --> <!-- begin-model-doc --> Indicates if the page should be displayed. <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Precondition Expression</em>' attribute. |
| * @see #setPreconditionExpression(String) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_PreconditionExpression() |
| * @model |
| * @generated |
| */ |
| String getPreconditionExpression(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#getPreconditionExpression <em>Precondition |
| * Expression</em>}' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Precondition Expression</em>' attribute. |
| * @see #getPreconditionExpression() |
| * @generated |
| */ |
| void setPreconditionExpression(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Groups</b></em>' reference list. The list contents are of type |
| * {@link org.eclipse.eef.EEFGroupDescription}. <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc |
| * --> References the Groups which are visible in a Page. If not specified, the EEF runtime looks for all the Groups |
| * defined under the View containing the Page that have a domainClass which is equal or a super class of the |
| * domainClass of the Page and use them following the order of the inheritance tree of the EObject. <!-- |
| * end-model-doc --> |
| * |
| * @return the value of the '<em>Groups</em>' reference list. |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_Groups() |
| * @model |
| * @generated |
| */ |
| EList<EEFGroupDescription> getGroups(); |
| |
| /** |
| * Returns the value of the '<em><b>Semantic Validation Rules</b></em>' containment reference list. The list |
| * contents are of type {@link org.eclipse.eef.EEFSemanticValidationRuleDescription}. <!-- begin-user-doc --> <!-- |
| * end-user-doc --> <!-- begin-model-doc --> The validation rules used to validate the semantic element of the page. |
| * <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Semantic Validation Rules</em>' containment reference list. |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_SemanticValidationRules() |
| * @model containment="true" resolveProxies="true" |
| * @generated |
| */ |
| EList<EEFSemanticValidationRuleDescription> getSemanticValidationRules(); |
| |
| /** |
| * Returns the value of the '<em><b>Indented</b></em>' attribute. The default value is <code>"false"</code>. <!-- |
| * begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Indented</em>' attribute isn't clear, there really should be more of a description |
| * here... |
| * </p> |
| * <!-- end-user-doc --> |
| * |
| * @return the value of the '<em>Indented</em>' attribute. |
| * @see #setIndented(boolean) |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_Indented() |
| * @model default="false" |
| * @generated |
| */ |
| boolean isIndented(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.eef.EEFPageDescription#isIndented <em>Indented</em>}' attribute. <!-- |
| * begin-user-doc --> <!-- end-user-doc --> |
| * |
| * @param value |
| * the new value of the '<em>Indented</em>' attribute. |
| * @see #isIndented() |
| * @generated |
| */ |
| void setIndented(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Actions</b></em>' containment reference list. The list contents are of type |
| * {@link org.eclipse.eef.EEFToolbarAction}. <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> |
| * Defines the toolbar's actions of this page. <!-- end-model-doc --> |
| * |
| * @return the value of the '<em>Actions</em>' containment reference list. |
| * @see org.eclipse.eef.EefPackage#getEEFPageDescription_Actions() |
| * @model containment="true" resolveProxies="true" |
| * @generated |
| */ |
| EList<EEFToolbarAction> getActions(); |
| |
| } // EEFPageDescription |
