oracle.jdeveloper.java.view

Interface JavaElementSelector<T extends View>

Type Parameters:

T - Subtype of View.

public interface JavaElementSelector<T extends View>

An JavaElementSelectoris an interface which implementations are used to find selected Java element from a view. The implementation of JavaElementSelectorhas to be public class with a default public construct so that the new instance be created by calling Class.newInstance(). Each view can have one or more implementations of ElementSelectorto find currently selected Java element. The ElementSelectors should be registered in extension.xml within java-selector-hookelement.

Example - CodeEditorElementSelector should be able to find selected Java element from CodeEditor view:

 <java-selector-hook xmlns="http://xmlns.oracle.com/ide/extension">
 <viewJavaElementSelector
 selector-class="oracle.jdevimpl.java.editing.CodeEditorElementSelector"
 view-class="oracle.ide.ceditor.CodeEditor"/>
 </java-selector-hook>
 

To force usage of concrete ElementSelector for only once withouth any registration the JavaElementSelectorcan be set as a propery of the Context. Look at the constant SOURCE_ELEMENT_SELECTOR.

When implementing method #getCurrentElement(Context,T)try to return the most detail source element which is currently selected, for example the caret is within the element code.

The JavaElementSelector.SelectedElementto return can be created either by method createSelectedSourceElement(SourceElement)or createSelectedJavaPackage(JavaPackage)

The JavaElementSelectoris used by module refactoring-java to refactor or find usages of Java elements. It is supposed that each view which wants to refactoring any Java element which is currently selected can supply this element using JavaElementSelector.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JavaElementSelector.SelectedElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SOURCE_ELEMENT_SELECTOR Constant used to force usage concrete class of JavaElementSelectorfor current View in Context.

Method Summary

Modifier and Type	Method and Description
static JavaElementSelector.SelectedElement	createSelectedJavaPackage(JavaPackage javaElement)
static JavaElementSelector.SelectedElement	createSelectedSourceElement(SourceElement sourceElement)
JavaElementSelector.SelectedElement	getCurrentElement(Context context, T view)

Field Detail

SOURCE_ELEMENT_SELECTOR

static final java.lang.String SOURCE_ELEMENT_SELECTOR

Constant used to force usage concrete class of JavaElementSelectorfor current View in Context.

Usage:

 public static class MyElementSelector extends JavaElementSelector {
 ...
 }
 Context c;

 c.setProperty(ElementSelector.SOURCE_ELEMENT_SELECTOR, MyElementSelector.class);
 

See Also:

Constant Field Values

Method Detail

getCurrentElement

JavaElementSelector.SelectedElement getCurrentElement(Context context,
                                                      T view)

createSelectedSourceElement

static JavaElementSelector.SelectedElement createSelectedSourceElement(SourceElement sourceElement)

createSelectedJavaPackage

static JavaElementSelector.SelectedElement createSelectedJavaPackage(JavaPackage javaElement)