ITreeItemDescriptor.java

/*******************************************************************************
 * Copyright (c) 2006-2013 The RCP Company 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:
 *     The RCP Company - initial API and implementation
 *******************************************************************************/
package com.rcpcompany.uibindings;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;

/**
 * <!-- begin-user-doc -->
 * 
 * This interface describes one possible item in a viewer tree. The information can come from a
 * number of sources:
 * <ul>
 * <li>It can be declared via the <code>uibindings</code> extension point</li>
 * <li>It can be added directly to {@link IManager#getTreeItems()}</li>
 * <li>It can be constructed automatically if no information is available</li>
 * </ul>
 * 
 * <!-- end-user-doc -->
 * 
 * <p>
 * The following features are supported:
 * <ul>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getId <em>Id</em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getChildRelations <em>Child Relations
 * </em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getCe <em>Ce</em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getModelTypes <em>Model Types</em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getParentRelations <em>Parent Relations
 * </em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getPrimaryParent <em>Primary Parent
 * </em>}</li>
 * <li>{@link com.rcpcompany.uibindings.ITreeItemDescriptor#isEmptyFolderHidden <em>Empty Folder
 * Hidden</em>}</li>
 * </ul>
 * </p>
 * 
 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor()
 * @generated
 */
public interface ITreeItemDescriptor extends EObject, IArgumentProvider {
	/**
	 * Returns the value of the '<em><b>Id</b></em>' attribute. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Id</em>' attribute isn't clear, there really should be more of a
	 * description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Id</em>' attribute.
	 * @see #setId(String)
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_Id()
	 * @generated
	 */
	String getId();

	/**
	 * Sets the value of the '{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getId
	 * <em>Id</em>}' attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Id</em>' attribute.
	 * @see #getId()
	 * @generated
	 */
	void setId(String value);

	/**
	 * Returns the value of the '<em><b>Child Relations</b></em>' reference list. The list contents
	 * are of type {@link com.rcpcompany.uibindings.ITreeItemRelation}. It is bidirectional and its
	 * opposite is '{@link com.rcpcompany.uibindings.ITreeItemRelation#getParent <em>Parent</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Child Relations</em>' reference list isn't clear, there really
	 * should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Child Relations</em>' reference list.
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_ChildRelations()
	 * @see com.rcpcompany.uibindings.ITreeItemRelation#getParent
	 * @generated
	 */
	EList<ITreeItemRelation> getChildRelations();

	/**
	 * Returns the value of the '<em><b>Ce</b></em>' attribute. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Ce</em>' attribute isn't clear, there really should be more of a
	 * description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Ce</em>' attribute.
	 * @see #setCe(IConfigurationElement)
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_Ce()
	 * @generated
	 */
	IConfigurationElement getCe();

	/**
	 * Sets the value of the '{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getCe
	 * <em>Ce</em>}' attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Ce</em>' attribute.
	 * @see #getCe()
	 * @generated
	 */
	void setCe(IConfigurationElement value);

	/**
	 * Returns the value of the '<em><b>Model Types</b></em>' attribute list. The list contents are
	 * of type {@link java.lang.String}. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Model Types</em>' attribute list isn't clear, there really should
	 * be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Model Types</em>' attribute list.
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_ModelTypes()
	 * @generated
	 */
	EList<String> getModelTypes();

	/**
	 * Returns the value of the '<em><b>Parent Relations</b></em>' reference list. The list contents
	 * are of type {@link com.rcpcompany.uibindings.ITreeItemRelation}. It is bidirectional and its
	 * opposite is '{@link com.rcpcompany.uibindings.ITreeItemRelation#getDescriptor
	 * <em>Descriptor</em>}'. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Parent Relations</em>' reference list isn't clear, there really
	 * should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Parent Relations</em>' reference list.
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_ParentRelations()
	 * @see com.rcpcompany.uibindings.ITreeItemRelation#getDescriptor
	 * @generated
	 */
	EList<ITreeItemRelation> getParentRelations();

	/**
	 * Returns the value of the '<em><b>Primary Parent</b></em>' reference. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Primary Parent</em>' reference isn't clear, there really should be
	 * more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Primary Parent</em>' reference.
	 * @see #setPrimaryParent(ITreeItemDescriptor)
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_PrimaryParent()
	 * @generated
	 */
	ITreeItemDescriptor getPrimaryParent();

	/**
	 * Sets the value of the '{@link com.rcpcompany.uibindings.ITreeItemDescriptor#getPrimaryParent
	 * <em>Primary Parent</em>}' reference. <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Primary Parent</em>' reference.
	 * @see #getPrimaryParent()
	 * @generated
	 */
	void setPrimaryParent(ITreeItemDescriptor value);

	/**
	 * Returns the value of the '<em><b>Empty Folder Hidden</b></em>' attribute. The default value
	 * is <code>"false"</code>. <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Empty Folder Hidden</em>' attribute isn't clear, there really
	 * should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Empty Folder Hidden</em>' attribute.
	 * @see #setEmptyFolderHidden(boolean)
	 * @see com.rcpcompany.uibindings.IUIBindingsPackage#getTreeItemDescriptor_EmptyFolderHidden()
	 * @generated
	 */
	boolean isEmptyFolderHidden();

	/**
	 * Sets the value of the '
	 * {@link com.rcpcompany.uibindings.ITreeItemDescriptor#isEmptyFolderHidden
	 * <em>Empty Folder Hidden</em>}' attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Empty Folder Hidden</em>' attribute.
	 * @see #isEmptyFolderHidden()
	 * @generated
	 */
	void setEmptyFolderHidden(boolean value);

} // ITreeItemDescriptor