Class QlRenameElementContext

  • All Implemented Interfaces:
    org.eclipse.xtext.ui.refactoring.IChangeRedirector.Aware, org.eclipse.xtext.ui.refactoring.ui.IRenameElementContext

    public class QlRenameElementContext
    extends org.eclipse.xtext.ui.refactoring.ui.IRenameElementContext.Impl
    Special IRenameElementContext.Impl for Ql. Ql refactoring context should have some additional information for creating changes in refactoring mechanism. The main reason of expanding API is that EmbeddedEditor doesn't have real resource file.
    For more details look to getViewer(), getXtextDocument(), getIFile().
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.eclipse.xtext.ui.refactoring.ui.IRenameElementContext

        org.eclipse.xtext.ui.refactoring.ui.IRenameElementContext.Impl
    • Constructor Summary

      Constructors 
      Constructor Description
      QlRenameElementContext​(org.eclipse.emf.common.util.URI targetElementURI, org.eclipse.emf.ecore.EClass targetElementEClass, org.eclipse.emf.ecore.EObject targetObject, org.eclipse.emf.ecore.EObject initializeTargetObject)
      Constructor
      QlRenameElementContext​(org.eclipse.emf.common.util.URI targetElementURI, org.eclipse.emf.ecore.EClass targetElementEClass, org.eclipse.ui.IEditorPart triggeringEditor, ISelection triggeringEditorSelection, org.eclipse.emf.common.util.URI contextResourceURI, org.eclipse.emf.ecore.EObject targetObject, org.eclipse.emf.ecore.EObject initializeTargetObject)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.eclipse.core.resources.IFile getIFile()
      Gets actual IFile for refactoring
      org.eclipse.emf.ecore.EObject getInitializeTargetObject()
      Gets initial object for refactoring from selection
      org.eclipse.emf.ecore.EObject getTargetObject()
      Gets target object for refactoring
      org.eclipse.xtext.ui.editor.XtextSourceViewer getViewer()
      Gets actual XtextSourceViewer for refactoring
      org.eclipse.xtext.ui.editor.model.IXtextDocument getXtextDocument()
      Gets actual IXtextDocument for refactoring
      void setIFile​(org.eclipse.core.resources.IFile file)
      Sets actual IFile for refactoring
      void setViewer​(org.eclipse.xtext.ui.editor.XtextSourceViewer viewer)
      Sets actual XtextSourceViewer for refactoring
      void setXtextDocument​(org.eclipse.xtext.ui.editor.model.IXtextDocument document)
      Sets actual IXtextDocument for refactoring
      • Methods inherited from class org.eclipse.xtext.ui.refactoring.ui.IRenameElementContext.Impl

        getChangeRedirector, getContextResourceURI, getTargetElementEClass, getTargetElementURI, getTriggeringEditor, getTriggeringEditorSelection, setChangeRedirector
    • Constructor Detail

      • QlRenameElementContext

        public QlRenameElementContext​(org.eclipse.emf.common.util.URI targetElementURI,
                                      org.eclipse.emf.ecore.EClass targetElementEClass,
                                      org.eclipse.emf.ecore.EObject targetObject,
                                      org.eclipse.emf.ecore.EObject initializeTargetObject)
        Constructor
        Parameters:
        targetElementURI - uri of the target element for refactoring
        targetElementEClass - eClass of the target element for refactoring
        targetObject - target object for refactoring
        initializeTargetObject - initial object for refactoring from selection
      • QlRenameElementContext

        public QlRenameElementContext​(org.eclipse.emf.common.util.URI targetElementURI,
                                      org.eclipse.emf.ecore.EClass targetElementEClass,
                                      org.eclipse.ui.IEditorPart triggeringEditor,
                                      ISelection triggeringEditorSelection,
                                      org.eclipse.emf.common.util.URI contextResourceURI,
                                      org.eclipse.emf.ecore.EObject targetObject,
                                      org.eclipse.emf.ecore.EObject initializeTargetObject)
        Constructor
        Parameters:
        targetElementURI - uri of the target element for refactoring
        targetElementEClass - eClass of the target element for refactoring
        triggeringEditor - editor where refactoring was called
        triggeringEditorSelection - refactoring initial selection
        contextResourceURI - resource uri
        targetObject - target object for refactoring
        initializeTargetObject - initial object for refactoring from selection
    • Method Detail

      • getTargetObject

        public org.eclipse.emf.ecore.EObject getTargetObject()
        Gets target object for refactoring
        Returns:
        target object for refactoring
      • getInitializeTargetObject

        public org.eclipse.emf.ecore.EObject getInitializeTargetObject()
        Gets initial object for refactoring from selection
        Returns:
        initial object for refactoring from selection
      • setViewer

        public void setViewer​(org.eclipse.xtext.ui.editor.XtextSourceViewer viewer)
        Sets actual XtextSourceViewer for refactoring
        Parameters:
        viewer - actual XtextSourceViewer for refactoring, can't be null
      • getViewer

        public org.eclipse.xtext.ui.editor.XtextSourceViewer getViewer()
        Gets actual XtextSourceViewer for refactoring
        Returns:
        actual XtextSourceViewer for refactoring, never null
      • getXtextDocument

        public org.eclipse.xtext.ui.editor.model.IXtextDocument getXtextDocument()
        Gets actual IXtextDocument for refactoring
        Returns:
        actual IXtextDocument for refactoring, never null
      • setXtextDocument

        public void setXtextDocument​(org.eclipse.xtext.ui.editor.model.IXtextDocument document)
        Sets actual IXtextDocument for refactoring
        Parameters:
        viewer - actual IXtextDocument for refactoring, can't be null
      • setIFile

        public void setIFile​(org.eclipse.core.resources.IFile file)
        Sets actual IFile for refactoring
        Parameters:
        viewer - actual IFile for refactoring, can't be null
      • getIFile

        public org.eclipse.core.resources.IFile getIFile()
        Gets actual IFile for refactoring
        Returns:
        actual IFile for refactoring, never null