001: /*
002: * uDig - User Friendly Desktop Internet GIS client http://udig.refractions.net (C) 2004,
003: * Refractions Research Inc. This library is free software; you can redistribute it and/or modify it
004: * under the terms of the GNU Lesser General Public License as published by the Free Software
005: * Foundation; version 2.1 of the License. This library is distributed in the hope that it will be
006: * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
007: * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
008: */
009: package net.refractions.udig.project.internal.render;
010:
011: import net.refractions.udig.project.render.IRenderContext;
012: import net.refractions.udig.project.render.IRenderer;
013:
014: import org.eclipse.emf.ecore.EObject;
015:
016: /**
017: * The EMF object extension to the IRenderer interface. Non-udig developers should not have to reference this class.
018: *
019: * @author Jesse
020: * @since 1.0.0
021: * @model abstract="true"
022: */
023: public interface Renderer extends EObject, IRenderer {
024:
025: /**
026: * <!-- begin-user-doc --> <!-- end-user-doc -->
027: *
028: * @generated
029: */
030: String copyright = "uDig - User Friendly Desktop Internet GIS client http://udig.refractions.net (C) 2004, Refractions Research Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details."; //$NON-NLS-1$
031:
032: /**
033: * Returns the current state of rendering.
034: * <p>
035: * The state is the current state of the {@linkplain org.eclipse.core.runtime.jobs.Job}
036: * </p>
037: * Options are:
038: * <ul>
039: * <li> {@linkplain #RENDERING} </li>
040: * <li> {@linkplain #DONE} </li>
041: * <li> {@linkplain #NEVER} </li>
042: * <li> {@linkplain #DISPOSED} </li>
043: * </ul>
044: *
045: * @return the current state of rendering.
046: * @uml.property name="state"
047: * @model default="0"
048: */
049: public int getState();
050:
051: /**
052: * Sets the value of the '{@link net.refractions.udig.project.internal.render.Renderer#getState <em>State</em>}'
053: * attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
054: *
055: * @param value the new value of the '<em>State</em>' attribute.
056: * @see #getState()
057: * @generated
058: */
059: void setState(int value);
060:
061: /**
062: * Returns the value of the '<em><b>Name</b></em>' attribute. <!-- begin-user-doc --> <!--
063: * end-user-doc -->
064: *
065: * @return the value of the '<em>Name</em>' attribute.
066: * @see #setName(String)
067: * @see net.refractions.udig.project.internal.render.RenderPackage#getRenderer_Name()
068: * @model id="true"
069: * @generated
070: */
071: String getName();
072:
073: /**
074: * Sets the value of the '{@link net.refractions.udig.project.internal.render.Renderer#getName <em>Name</em>}'
075: * attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
076: *
077: * @param value the new value of the '<em>Name</em>' attribute.
078: * @see #getName()
079: * @generated
080: */
081: void setName(String value);
082:
083: /**
084: * Returns the value of the '<em><b>Toolkit</b></em>' attribute. <!-- begin-user-doc -->
085: * <p>
086: * If the meaning of the '<em>Toolkit</em>' attribute isn't clear, there really should be
087: * more of a description here...
088: * </p>
089: * <!-- end-user-doc -->
090: *
091: * @return the value of the '<em>Toolkit</em>' attribute.
092: * @see net.refractions.udig.project.internal.render.RenderPackage#getRenderer_Context()
093: * @model transient="true" resolveProxies="false"
094: */
095: IRenderContext getContext();
096:
097: /**
098: * Sets the value of the '{@link net.refractions.udig.project.internal.render.Renderer#getContext <em>Context</em>}'
099: * reference. <!-- begin-user-doc --> <!-- end-user-doc -->
100: *
101: * @param value the new value of the '<em>Context</em>' reference.
102: * @see #getContext()
103: * @generated
104: */
105: void setContext(IRenderContext context);
106:
107: /**
108: * Informs the renderer to dispose of resources
109: *
110: * @model
111: */
112: public void dispose();
113:
114: }
|