org.eclipse.jpt.core
Interface JpaStructureNode

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaNode, Model
All Known Subinterfaces:
ClassRef, EntityMappings, JavaPersistentAttribute, JavaPersistentType, MappingFileRef, OrmPersistentAttribute, OrmPersistentType, OrmXml, Persistence, PersistenceUnit, PersistenceXml, PersistentAttribute, PersistentType

public interface JpaStructureNode
extends JpaNode

Implement this interface for objects that appear in the Structure view This is used by JpaSelection to determine selection in the editor. Details pages are also provided for each JpaStructureNode. I did not implement JpaContextNode and I'm not even sure we should implement JpaNode. It is possibly someone could want a structure node that is not actually a contextNode in the model.//TODO Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Method Summary
 void dispose()
          Dispose of this structureNode and dispose of chil structureNodes.
 java.lang.String getId()
          Return a unique identifier for all of this class of structure nodes
 TextRange getSelectionTextRange()
          Return the text range to be used to select text in the editor corresponding to this node.
 JpaStructureNode getStructureNode(int textOffset)
          Return the structure node at the given offset.
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent, getResource
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getStructureNode

JpaStructureNode getStructureNode(int textOffset)
Return the structure node at the given offset.


getSelectionTextRange

TextRange getSelectionTextRange()
Return the text range to be used to select text in the editor corresponding to this node.


getId

java.lang.String getId()
Return a unique identifier for all of this class of structure nodes


dispose

void dispose()
Dispose of this structureNode and dispose of chil structureNodes. Typically this would be used to update the JpaFile rootStructureNodes.