| /** |
| * Copyright (c) 2013, 2017 CEA LIST & LIFL |
| * |
| * 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: |
| * Cedric Dumoulin Cedric.dumoulin@lifl.fr - Initial API and implementation |
| * Quentin Le Menez quentin.lemenez@cea.fr |
| * |
| */ |
| package org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers; |
| |
| import java.util.List; |
| |
| import org.eclipse.gmf.runtime.notation.View; |
| |
| import org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.LayersException; |
| import org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.NotFoundException; |
| |
| import org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.command.ComputePropertyValueCommand; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Layer Expression</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getName <em>Name</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getDescription <em>Description</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#isLayerEnabledInternal <em>Is Layer Enabled Internal</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#isLayerEnabled <em>Is Layer Enabled</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#isBranchEnabled <em>Is Branch Enabled</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getOwningLayersStack <em>Owning Layers Stack</em>}</li> |
| * <li>{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getState <em>State</em>}</li> |
| * </ul> |
| * |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface LayerExpression extends ApplicationDependantElement { |
| /** |
| * Returns the value of the '<em><b>Name</b></em>' attribute. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Name</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Name</em>' attribute. |
| * @see #setName(String) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_Name() |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.String" required="true" ordered="false" |
| * @generated |
| */ |
| String getName(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getName <em>Name</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Name</em>' attribute. |
| * @see #getName() |
| * @generated |
| */ |
| void setName(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Description</b></em>' attribute. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Description</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Description</em>' attribute. |
| * @see #setDescription(String) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_Description() |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.String" required="true" ordered="false" |
| * @generated |
| */ |
| String getDescription(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getDescription <em>Description</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Description</em>' attribute. |
| * @see #getDescription() |
| * @generated |
| */ |
| void setDescription(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Is Layer Enabled Internal</b></em>' attribute. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Is Layer Enabled Internal</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Is Layer Enabled Internal</em>' attribute. |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_IsLayerEnabledInternal() |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.boolean" required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| boolean isLayerEnabledInternal(); |
| |
| /** |
| * Returns the value of the '<em><b>Is Layer Enabled</b></em>' attribute. |
| * The default value is <code>"true"</code>. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Is Layer Enabled</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Is Layer Enabled</em>' attribute. |
| * @see #setIsLayerEnabled(boolean) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_IsLayerEnabled() |
| * @model default="true" dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isLayerEnabled(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#isLayerEnabled <em>Is Layer Enabled</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Layer Enabled</em>' attribute. |
| * @see #isLayerEnabled() |
| * @generated |
| */ |
| void setIsLayerEnabled(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Is Branch Enabled</b></em>' attribute. |
| * The default value is <code>"true"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Is the branch from this node to the root enabled ? |
| * A branch is enabled if all node of the branch are enabled. |
| * In other world, if an ancestor node is disable, the branch is disabled. |
| * Setting the value of this node set the value of the subnodes. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Branch Enabled</em>' attribute. |
| * @see #setIsBranchEnabled(boolean) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_IsBranchEnabled() |
| * @model default="true" dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.boolean" required="true" transient="true" ordered="false" |
| * @generated |
| */ |
| boolean isBranchEnabled(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#isBranchEnabled <em>Is Branch Enabled</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Branch Enabled</em>' attribute. |
| * @see #isBranchEnabled() |
| * @generated |
| */ |
| void setIsBranchEnabled(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Owning Layers Stack</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Owning Layers Stack</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Owning Layers Stack</em>' reference. |
| * @see #setOwningLayersStack(LayersStack) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_OwningLayersStack() |
| * @model ordered="false" |
| * @generated |
| */ |
| LayersStack getOwningLayersStack(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getOwningLayersStack <em>Owning Layers Stack</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Owning Layers Stack</em>' reference. |
| * @see #getOwningLayersStack() |
| * @generated |
| */ |
| void setOwningLayersStack(LayersStack value); |
| |
| /** |
| * Returns the value of the '<em><b>State</b></em>' attribute. |
| * The default value is <code>"detached"</code>. |
| * The literals are from the enumeration {@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerState}. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>State</em>' attribute isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>State</em>' attribute. |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerState |
| * @see #setState(LayerState) |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersPackage#getLayerExpression_State() |
| * @model default="detached" unique="false" required="true" ordered="false" |
| * @generated |
| */ |
| LayerState getState(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerExpression#getState <em>State</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>State</em>' attribute. |
| * @see org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayerState |
| * @see #getState() |
| * @generated |
| */ |
| void setState(LayerState value); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.ComputePropertyValueCommand" required="true" ordered="false" exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" viewRequired="true" viewOrdered="false" propertyRequired="true" propertyOrdered="false" |
| * @generated |
| */ |
| ComputePropertyValueCommand getComputePropertyValueCommand(View view, Property property) throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.ComputePropertyValueCommand" exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" viewMany="true" propertyRequired="true" propertyOrdered="false" |
| * @generated |
| */ |
| List<ComputePropertyValueCommand> getViewsComputePropertyValueCommand(List<View> view, Property property) throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @model dataType="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.ComputePropertyValueCommand" exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" viewRequired="true" viewOrdered="false" propertyRequired="true" propertyMany="true" |
| * @generated |
| */ |
| List<ComputePropertyValueCommand> getPropertiesComputePropertyValueCommand(View view, List<Property> property) throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Method called to specify that this Layer should be initialized for the specified LayerStack. |
| * Init this Layer for the specified LayersStack. |
| * This method is called by the LayersStack when it detect that tha layer is attached to it. |
| * |
| * <!-- end-model-doc --> |
| * @model owningLayersStackRequired="true" owningLayersStackOrdered="false" |
| * @generated |
| */ |
| void attachToLayersStack(LayersStack owningLayersStack); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A checked version of getOwningLayersStack. |
| * |
| * <!-- end-model-doc --> |
| * @model kind="operation" required="true" ordered="false" exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.NotFoundException" |
| * @generated |
| */ |
| LayersStack getLayersStack() throws NotFoundException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * This method is called by the class immediately after entering in attached state. |
| * The methodcan be used to start the layer behaviors. |
| * <!-- end-model-doc --> |
| * @model exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" |
| * @generated |
| */ |
| void enterAttachedState() throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Try to attach this Layer. If successful, the state go to "attached". Otherwise, an exception is thrown. |
| * A Layer can be attached if its required attributes are set. |
| * Required attributes: |
| * <ul> |
| * <li>application</li> |
| * <li>owningLayerStack</li> |
| * <li>parent container</li> |
| * <li></li> |
| * </ul> |
| * Just after enterring in "attached" state, the enterAttachedState() method is called. |
| * If this Layer is successfully attached, then attach subLayers. |
| * <!-- end-model-doc --> |
| * @model exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" |
| * @generated |
| */ |
| void attach() throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Detach the Layer. The state go to "detached". |
| * Associated behavior are stopped. |
| * <!-- end-model-doc --> |
| * @model exceptions="org.eclipse.papyrus.internal.infra.gmfdiag.layers.model.layers.LayersException" |
| * @generated |
| */ |
| void detach() throws LayersException; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * This method is called just before this Layer leave the attached state. |
| * |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| void exitAttachedState(); |
| |
| } // LayerExpression |