Skip to content

Commit

Permalink
Added a new design to select and edit getters and setters for fields
Browse files Browse the repository at this point in the history 
within the refactoring #1080
  • Loading branch information
@amartya4256
amartya4256 committed Feb 12, 2024
1 parent 56afdff commit 4ccd225
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 49 deletions.
2 changes: 2 additions & 0 deletions ...se.jdt.ui/ui refactoring/org/eclipse/jdt/internal/ui/refactoring/RefactoringMessages.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -948,6 +948,8 @@ public final class RefactoringMessages extends NLS {

public static String SelfEncapsulateFieldInputPage_description;

public static String SelfEncapsulateFieldInputPage_selected_field_name;

public static String SelfEncapsulateFieldInputPage_field_access;

public static String SelfEncapsulateFieldInputPage_first_method;
Expand Down
1 change: 1 addition & 0 deletions ...se.jdt.ui/ui refactoring/org/eclipse/jdt/internal/ui/refactoring/refactoringui.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ InlineMethodWizard_page_title=Inline Method
#######################################

SelfEncapsulateField_sef=Encapsulate Fields
SelfEncapsulateFieldInputPage_selected_field_name=Selected Field Name:
SelfEncapsulateFieldInputPage_field_access=Field access in declaring type:
SelfEncapsulateFieldInputPage_use_setter_getter=us&e setter and getter
SelfEncapsulateFieldInputPage_keep_references=&keep field reference
Expand Down
161 changes: 112 additions & 49 deletions ...efactoring/org/eclipse/jdt/internal/ui/refactoring/sef/SelfEncapsulateFieldInputPage.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@
import java.util.stream.Stream;

import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.TreeEditor;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.KeyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
Expand Down Expand Up @@ -73,7 +72,6 @@
public class SelfEncapsulateFieldInputPage extends UserInputWizardPage {

private static final String REFACTORING_TYPE= "refactoringType"; //$NON-NLS-1$
private static final String TEXT_WIDGET= "textWidget"; //$NON-NLS-1$
private static final String REFACTORING= "refactoring"; //$NON-NLS-1$
private static final String WARNING_ICON= "warningIcon"; //$NON-NLS-1$
private static final String WARNING_TEXT= "warningText"; //$NON-NLS-1$
Expand All @@ -84,6 +82,7 @@ public class SelfEncapsulateFieldInputPage extends UserInputWizardPage {
private HashMap<SelfEncapsulateFieldRefactoring, TreeItem> refactoringButtonMap = new HashMap<>();

private HashMap<String, Label> warningLabelMap = new HashMap<>();
private SelfEncapsulateFieldRefactoring selectedField;

private static final String GENERATE_JAVADOC= "GenerateJavadoc"; //$NON-NLS-1$

Expand All @@ -102,43 +101,6 @@ public List<SelfEncapsulateFieldRefactoring> getSelectedRefactorings() {
.filter(SelfEncapsulateFieldRefactoring::isSeletced).toList();
}

private void enableEditing(TreeItem item, Tree tree, String textData, RefactoringType refactoringType, SelfEncapsulateFieldRefactoring refactoring) {
Text text = new Text(tree, SWT.BORDER);
text.setSize(2, text.getSize().y);
text.setText(textData);
TreeEditor editor = new TreeEditor(tree);
editor.minimumWidth = 200;

item.setData("textEditor", editor); //$NON-NLS-1$
item.setData(TEXT_WIDGET, text);
item.setData(REFACTORING_TYPE, refactoringType);
item.setData(REFACTORING, refactoring);

text.addFocusListener(new FocusAdapter() {
@Override
public void focusLost(FocusEvent e) {
Text textWidget = (Text) item.getData(TEXT_WIDGET);
item.setText(textWidget.getText());
String methodName = item.getChecked() ? textWidget.getText() : ""; //$NON-NLS-1$
if(refactoringType == RefactoringType.GETTER) {
refactoring.setGetterName(methodName);
} else {
refactoring.setSetterName(methodName);
}

processValidation();
}
});

text.addTraverseListener(event -> {
if (event.detail == SWT.TRAVERSE_RETURN) {
Text textWidget = (Text) item.getData(TEXT_WIDGET);
item.setText(textWidget.getText());
}
});
editor.setEditor(text, item);
}

@Override
public void createControl(Composite parent) {
SelfEncapsulateFieldWizard wizard = (SelfEncapsulateFieldWizard) getRefactoringWizard();
Expand All @@ -152,18 +114,96 @@ public void createControl(Composite parent) {
initializeDialogUnits(result);
result.setLayout(new GridLayout(3, false));

Tree tree = new Tree(result, SWT.CHECK);
tree.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
Composite selectorGroup = new Composite(result, SWT.NONE);
selectorGroup.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, false, 3, 1));
selectorGroup.setLayout(new GridLayout(2, false));

Tree tree = new Tree(selectorGroup, SWT.CHECK);
tree.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, true, 1, 1));

Composite editorContainerGroup = new Composite(selectorGroup, SWT.NONE);
editorContainerGroup.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, true));
editorContainerGroup.setLayout(new GridLayout(1, false));
editorContainerGroup.setEnabled(false);

Label fieldLabel= new Label(editorContainerGroup, SWT.LEFT);
fieldLabel.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 1, 1));
fieldLabel.setText(RefactoringMessages.SelfEncapsulateFieldInputPage_selected_field_name);
fEnablements.add(fieldLabel);

Composite editorGroup = new Composite(editorContainerGroup, SWT.NONE);
editorGroup.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, true));
GridLayout editorLayout = new GridLayout(2, false);
editorLayout.marginWidth = 0;
editorGroup.setLayout(editorLayout);

GridData textLayoutData = new GridData(SWT.FILL, SWT.LEFT, true, true);
textLayoutData.widthHint = SWT.DEFAULT;

Label getterLabel= new Label(editorGroup, SWT.LEFT);
getterLabel.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
getterLabel.setText(RefactoringMessages.SelfEncapsulateFieldInputPage_getter_name);
fEnablements.add(getterLabel);

Text getterText = new Text(editorGroup, SWT.LEFT | SWT.BORDER);
getterText.setLayoutData(textLayoutData);
getterText.addKeyListener(new KeyListener() {

@Override
public void keyReleased(KeyEvent e) {
selectedField.setGetterName(getterText.getText());
for (TreeItem treeItem : refactoringButtonMap.get(selectedField).getItems()) {
if (treeItem.getData(REFACTORING_TYPE) == RefactoringType.GETTER)
treeItem.setText(getterText.getText());
}
processValidation();
}

@Override
public void keyPressed(KeyEvent e) {
// Not needed
}
});
fEnablements.add(getterText);

Label setterLabel= new Label(editorGroup, SWT.LEFT);
setterLabel.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
setterLabel.setText(RefactoringMessages.SelfEncapsulateFieldInputPage_setter_name);
fEnablements.add(setterLabel);

Text setterText = new Text(editorGroup, SWT.LEFT | SWT.BORDER);
setterText.setLayoutData(textLayoutData);
setterText.addKeyListener(new KeyListener() {

@Override
public void keyReleased(KeyEvent e) {
selectedField.setSetterName(setterText.getText());
for (TreeItem treeItem : refactoringButtonMap.get(selectedField).getItems()) {
if (treeItem.getData(REFACTORING_TYPE) == RefactoringType.SETTER)
treeItem.setText(setterText.getText());
}
processValidation();
}

@Override
public void keyPressed(KeyEvent e) {
// Not needed
}
});
fEnablements.add(setterText);

tree.addListener(SWT.Selection, new Listener() {

@Override
public void handleEvent(Event event) {
TreeItem selectedItem = (TreeItem) event.item;
TreeItem parentItem = selectedItem.getParentItem();
System.out.println(event.detail);
selectField(editorContainerGroup, fieldLabel, getterText, setterText, parentItem == null ? selectedItem : parentItem);
if(event.detail == SWT.CHECK) {
TreeItem parentItem = selectedItem.getParentItem();
if(parentItem != null) { // Setter or Getter
SelfEncapsulateFieldRefactoring refactoring = (SelfEncapsulateFieldRefactoring) selectedItem.getData(REFACTORING);
String methodName = selectedItem.getChecked() ? ((Text) selectedItem.getData(TEXT_WIDGET)).getText() : ""; //$NON-NLS-1$
String methodName = ""; //$NON-NLS-1$
if ((RefactoringType) selectedItem.getData(REFACTORING_TYPE) == RefactoringType.GETTER) {
refactoring.setGetterName(methodName);
} else {
Expand All @@ -181,9 +221,9 @@ public void handleEvent(Event event) {
((SelfEncapsulateFieldRefactoring) item.getData(REFACTORING)).setSelected(selectedItem.getChecked());
}
}
updateRefactorings();
processValidation();
}
updateRefactorings();
processValidation();
}
});
fRefactorings.getRefactorings().forEach(refactoring -> {
Expand All @@ -192,17 +232,20 @@ public void handleEvent(Event event) {
TreeItem item = new TreeItem(tree, SWT.CHECK);
refactoringButtonMap.put(refactoring, item);
item.setChecked(isChecked);
item.setData(REFACTORING, refactoring);

TreeItem generateGetter = new TreeItem(item, SWT.CHECK);
generateGetter.setChecked(isChecked);
generateGetter.setText(refactoring.getGetterName());
enableEditing(generateGetter, tree, refactoring.getGetterName(), RefactoringType.GETTER, refactoring);
generateGetter.setData(REFACTORING_TYPE, RefactoringType.GETTER);
generateGetter.setData(REFACTORING, refactoring);

if(needsSetter(refactoring)) {
TreeItem generateSetter = new TreeItem(item, SWT.CHECK);
generateSetter.setChecked(isChecked);
generateSetter.setText(refactoring.getSetterName());
enableEditing(generateSetter, tree, refactoring.getSetterName(), RefactoringType.SETTER, refactoring);
generateSetter.setData(REFACTORING_TYPE, RefactoringType.SETTER);
generateSetter.setData(REFACTORING, refactoring);
} else {
fieldName += String.format(" %s", RefactoringMessages.SelfEncapsulateFieldInputPage_final_field) ; //$NON-NLS-1$
}
Expand Down Expand Up @@ -266,6 +309,26 @@ public void widgetSelected(SelectionEvent e) {
PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), IJavaHelpContextIds.SEF_WIZARD_PAGE);
}

private void selectField(Composite group, Label header, Text getter, Text setter, TreeItem parentItem) {
SelfEncapsulateFieldRefactoring refactoring = (SelfEncapsulateFieldRefactoring) parentItem.getData(REFACTORING);
this.selectedField = refactoring;
group.setEnabled(true);
header.setText(String.format("%s %s", RefactoringMessages.SelfEncapsulateFieldInputPage_selected_field_name, refactoring.getField().getElementName())); //$NON-NLS-1$
for (TreeItem child : parentItem.getItems()) {
if (child.getData(REFACTORING_TYPE) == RefactoringType.GETTER) {
getter.setText(child.getText());
}
else if (child.getData(REFACTORING_TYPE) == RefactoringType.SETTER) {
setter.setEnabled(true);
setter.setText(child.getText());
}
}
if (!needsSetter(refactoring)) {
setter.setEnabled(false);
setter.setText(RefactoringMessages.SelfEncapsulateFieldInputPage_final_field);
}
}

private void doOpenPreference() {
String id= CodeStylePreferencePage.PROP_ID;
IJavaProject project= fRefactorings.getRefactorings().get(0).getField().getJavaProject();
Expand Down

0 comments on commit 4ccd225

Please sign in to comment.