com.intellij.application.options.CodeStyleGenerationConfigurable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-impl Show documentation
Show all versions of java-impl Show documentation
A packaging of the IntelliJ Community Edition java-impl library.
This is release number 1 of trunk branch 142.
The newest version!
/*
* Copyright 2000-2011 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.application.options;
import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer;
import com.intellij.lang.java.JavaLanguage;
import com.intellij.openapi.application.ApplicationBundle;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurationException;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.project.ProjectManager;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.codeStyle.CodeStyleSettings;
import com.intellij.psi.codeStyle.CommonCodeStyleSettings;
import com.intellij.refactoring.RefactoringBundle;
import com.intellij.refactoring.ui.JavaVisibilityPanel;
import com.intellij.ui.IdeBorderFactory;
import com.intellij.ui.ToolbarDecorator;
import com.intellij.ui.components.JBList;
import javax.swing.*;
import java.awt.*;
import java.util.*;
import java.util.List;
public class CodeStyleGenerationConfigurable implements Configurable {
private final JavaVisibilityPanel myJavaVisibilityPanel;
JPanel myPanel;
private JTextField myFieldPrefixField;
private JTextField myStaticFieldPrefixField;
private JTextField myParameterPrefixField;
private JTextField myLocalVariablePrefixField;
private JTextField myFieldSuffixField;
private JTextField myStaticFieldSuffixField;
private JTextField myParameterSuffixField;
private JTextField myLocalVariableSuffixField;
private JCheckBox myCbPreferLongerNames;
private JCheckBox myCbLineCommentAtFirstColumn;
private JCheckBox myCbBlockCommentAtFirstColumn;
private final MembersOrderList myMembersOrderList;
private final CodeStyleSettings mySettings;
private JCheckBox myCbGenerateFinalParameters;
private JCheckBox myCbGenerateFinalLocals;
private JCheckBox myCbUseExternalAnnotations;
private JCheckBox myInsertOverrideAnnotationCheckBox;
private JPanel myMembersPanel;
private JCheckBox myRepeatSynchronizedCheckBox;
private JPanel myVisibilityPanel;
public CodeStyleGenerationConfigurable(CodeStyleSettings settings) {
mySettings = settings;
myMembersOrderList = new MembersOrderList();
myPanel.setBorder(IdeBorderFactory.createEmptyBorder(2, 2, 2, 2));
myJavaVisibilityPanel = new JavaVisibilityPanel(false, true, RefactoringBundle.message("default.visibility.border.title"));
}
public JComponent createComponent() {
final JPanel panel = ToolbarDecorator.createDecorator(myMembersOrderList)
.disableAddAction().disableRemoveAction().createPanel();
myMembersPanel.add(panel, BorderLayout.CENTER);
myVisibilityPanel.add(myJavaVisibilityPanel, BorderLayout.CENTER);
return myPanel;
}
public void disposeUIResources() {
}
public String getDisplayName() {
return ApplicationBundle.message("title.code.generation");
}
public String getHelpTopic() {
return "reference.settingsdialog.IDE.globalcodestyle.codegen";
}
/*private JPanel createNamingPanel() {
OptionGroup optionGroup = new OptionGroup("Naming");
myCbPreferLongerNames = new JCheckBox("Prefer longer names");
optionGroup.add(myCbPreferLongerNames);
optionGroup.add(new JLabel("Name prefix for:"));
myFieldPrefixField = new JTextField(8);
optionGroup.add(new JLabel("Field"), myFieldPrefixField, true);
myStaticFieldPrefixField = new JTextField(8);
optionGroup.add(new JLabel("Static field"), myStaticFieldPrefixField, true);
myParameterPrefixField = new JTextField(8);
optionGroup.add(new JLabel("Parameter"), myParameterPrefixField, true);
myLocalVariablePrefixField = new JTextField(8);
optionGroup.add(new JLabel("Local variable"), myLocalVariablePrefixField, true);
optionGroup.add(new JLabel("Name suffix for:"));
myFieldSuffixField = new JTextField(8);
optionGroup.add(new JLabel("Field"), myFieldSuffixField, true);
myStaticFieldSuffixField = new JTextField(8);
optionGroup.add(new JLabel("Static field"), myStaticFieldSuffixField, true);
myParameterSuffixField = new JTextField(8);
optionGroup.add(new JLabel("Parameter"), myParameterSuffixField, true);
myLocalVariableSuffixField = new JTextField(8);
optionGroup.add(new JLabel("Local variable"), myLocalVariableSuffixField, true);
return optionGroup.createPanel();
}
private JPanel createCommentPanel() {
OptionGroup optionGroup = new OptionGroup("Comment Code");
myCbLineCommentAtFirstColumn = new JCheckBox("Line comment at first column");
optionGroup.add(myCbLineCommentAtFirstColumn);
myCbBlockCommentAtFirstColumn = new JCheckBox("Block comment at first column");
optionGroup.add(myCbBlockCommentAtFirstColumn);
return optionGroup.createPanel();
}
private JPanel createRightMarginPanel() {
OptionGroup optionGroup = new OptionGroup("Wrapping ");
myRightMarginField = new JTextField(4);
optionGroup.add(new JLabel("Right margin (columns)") ,myRightMarginField);
return optionGroup.createPanel();
}
private JPanel createLineSeparatorPanel(){
OptionGroup optionGroup = new OptionGroup("Line Separator (for new files) ");
myLineSeparatorCombo = new JComboBox();
myLineSeparatorCombo.addItem(SYSTEM_DEPENDANT_STRING);
myLineSeparatorCombo.addItem(UNIX_STRING);
myLineSeparatorCombo.addItem(WINDOWS_STRING);
myLineSeparatorCombo.addItem(MACINTOSH_STRING);
optionGroup.add(myLineSeparatorCombo);
return optionGroup.createPanel();
}
private JPanel createKeepWhenReformattingPanel() {
OptionGroup optionGroup = new OptionGroup("Keep When Reformatting");
myCbKeepLineBreaks = new JCheckBox("Line breaks");
optionGroup.add(myCbKeepLineBreaks);
myCbKeepFirstColumnComment = new JCheckBox("Comment at first column");
optionGroup.add(myCbKeepFirstColumnComment);
myCbKeepControlStatementInOneLine = new JCheckBox("Control statement in one line");
optionGroup.add(myCbKeepControlStatementInOneLine);
return optionGroup.createPanel();
}
private JPanel createMembersOrderPanel() {
OptionGroup optionGroup = new OptionGroup("Order of Members");
JPanel panel = new JPanel(new GridBagLayout());
myMembersOrderList = new MembersOrderList();
panel.add(new JScrollPane(myMembersOrderList), new GridBagConstraints(0,0,1,2,1,1,GridBagConstraints.NORTH,GridBagConstraints.BOTH,new Insets(0,0,0,0), 0,0));
JButton moveUpButton = new JButton("Move Up");
moveUpButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e){
ListUtil.moveSelectedItemsUp(myMembersOrderList);
}
});
panel.add(moveUpButton, new GridBagConstraints(1,0,1,1,0,0,GridBagConstraints.NORTH,GridBagConstraints.HORIZONTAL,new Insets(0,5,5,0), 0,0));
JButton movDownButton = new JButton("Move Down");
moveDownButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e){
ListUtil.moveSelectedItemsDown(myMembersOrderList);
}
});
panel.add(movDownButton, new GridBagConstraints(1,1,1,1,0,1,GridBagConstraints.NORTH,GridBagConstraints.HORIZONTAL,new Insets(0,5,5,0), 0,0));
optionGroup.add(panel);
return optionGroup.createPanel();
}*/
public void reset(CodeStyleSettings settings) {
CommonCodeStyleSettings javaCommonSettings = settings.getCommonSettings(JavaLanguage.INSTANCE);
myCbPreferLongerNames.setSelected(settings.PREFER_LONGER_NAMES);
myFieldPrefixField.setText(settings.FIELD_NAME_PREFIX);
myStaticFieldPrefixField.setText(settings.STATIC_FIELD_NAME_PREFIX);
myParameterPrefixField.setText(settings.PARAMETER_NAME_PREFIX);
myLocalVariablePrefixField.setText(settings.LOCAL_VARIABLE_NAME_PREFIX);
myFieldSuffixField.setText(settings.FIELD_NAME_SUFFIX);
myStaticFieldSuffixField.setText(settings.STATIC_FIELD_NAME_SUFFIX);
myParameterSuffixField.setText(settings.PARAMETER_NAME_SUFFIX);
myLocalVariableSuffixField.setText(settings.LOCAL_VARIABLE_NAME_SUFFIX);
myCbLineCommentAtFirstColumn.setSelected(javaCommonSettings.LINE_COMMENT_AT_FIRST_COLUMN);
myCbBlockCommentAtFirstColumn.setSelected(javaCommonSettings.BLOCK_COMMENT_AT_FIRST_COLUMN);
myCbGenerateFinalLocals.setSelected(settings.GENERATE_FINAL_LOCALS);
myCbGenerateFinalParameters.setSelected(settings.GENERATE_FINAL_PARAMETERS);
myMembersOrderList.reset(mySettings);
myCbUseExternalAnnotations.setSelected(settings.USE_EXTERNAL_ANNOTATIONS);
myInsertOverrideAnnotationCheckBox.setSelected(settings.INSERT_OVERRIDE_ANNOTATION);
myRepeatSynchronizedCheckBox.setSelected(settings.REPEAT_SYNCHRONIZED);
myJavaVisibilityPanel.setVisibility(settings.VISIBILITY);
}
public void reset() {
reset(mySettings);
}
public void apply(CodeStyleSettings settings) throws ConfigurationException {
CommonCodeStyleSettings javaCommonSettings = settings.getCommonSettings(JavaLanguage.INSTANCE);
settings.PREFER_LONGER_NAMES = myCbPreferLongerNames.isSelected();
settings.FIELD_NAME_PREFIX = setPrefixSuffix(myFieldPrefixField.getText(), true);
settings.STATIC_FIELD_NAME_PREFIX = setPrefixSuffix(myStaticFieldPrefixField.getText(), true);
settings.PARAMETER_NAME_PREFIX = setPrefixSuffix(myParameterPrefixField.getText(), true);
settings.LOCAL_VARIABLE_NAME_PREFIX = setPrefixSuffix(myLocalVariablePrefixField.getText(), true);
settings.FIELD_NAME_SUFFIX = setPrefixSuffix(myFieldSuffixField.getText(), false);
settings.STATIC_FIELD_NAME_SUFFIX = setPrefixSuffix(myStaticFieldSuffixField.getText(), false);
settings.PARAMETER_NAME_SUFFIX = setPrefixSuffix(myParameterSuffixField.getText(), false);
settings.LOCAL_VARIABLE_NAME_SUFFIX = setPrefixSuffix(myLocalVariableSuffixField.getText(), false);
javaCommonSettings.LINE_COMMENT_AT_FIRST_COLUMN = myCbLineCommentAtFirstColumn.isSelected();
javaCommonSettings.BLOCK_COMMENT_AT_FIRST_COLUMN = myCbBlockCommentAtFirstColumn.isSelected();
settings.GENERATE_FINAL_LOCALS = myCbGenerateFinalLocals.isSelected();
settings.GENERATE_FINAL_PARAMETERS = myCbGenerateFinalParameters.isSelected();
settings.USE_EXTERNAL_ANNOTATIONS = myCbUseExternalAnnotations.isSelected();
settings.INSERT_OVERRIDE_ANNOTATION = myInsertOverrideAnnotationCheckBox.isSelected();
settings.REPEAT_SYNCHRONIZED = myRepeatSynchronizedCheckBox.isSelected();
settings.VISIBILITY = myJavaVisibilityPanel.getVisibility();
myMembersOrderList.apply(settings);
for (Project project : ProjectManager.getInstance().getOpenProjects()) {
DaemonCodeAnalyzer.getInstance(project).settingsChanged();
}
}
private static String setPrefixSuffix(String text, boolean prefix) throws ConfigurationException {
text = text.trim();
if (text.isEmpty()) return text;
if (!StringUtil.isJavaIdentifier(text)) {
throw new ConfigurationException("Not a valid java identifier part in " + (prefix ? "prefix" : "suffix") + " \'" + text + "\'");
}
return text;
}
public void apply() throws ConfigurationException {
apply(mySettings);
}
public boolean isModified(CodeStyleSettings settings) {
CommonCodeStyleSettings javaCommonSettings = settings.getCommonSettings(JavaLanguage.INSTANCE);
boolean isModified = isModified(myCbPreferLongerNames, settings.PREFER_LONGER_NAMES);
isModified |= isModified(myFieldPrefixField, settings.FIELD_NAME_PREFIX);
isModified |= isModified(myStaticFieldPrefixField, settings.STATIC_FIELD_NAME_PREFIX);
isModified |= isModified(myParameterPrefixField, settings.PARAMETER_NAME_PREFIX);
isModified |= isModified(myLocalVariablePrefixField, settings.LOCAL_VARIABLE_NAME_PREFIX);
isModified |= isModified(myFieldSuffixField, settings.FIELD_NAME_SUFFIX);
isModified |= isModified(myStaticFieldSuffixField, settings.STATIC_FIELD_NAME_SUFFIX);
isModified |= isModified(myParameterSuffixField, settings.PARAMETER_NAME_SUFFIX);
isModified |= isModified(myLocalVariableSuffixField, settings.LOCAL_VARIABLE_NAME_SUFFIX);
isModified |= isModified(myCbLineCommentAtFirstColumn, javaCommonSettings.LINE_COMMENT_AT_FIRST_COLUMN);
isModified |= isModified(myCbBlockCommentAtFirstColumn, javaCommonSettings.BLOCK_COMMENT_AT_FIRST_COLUMN);
isModified |= isModified(myCbGenerateFinalLocals, settings.GENERATE_FINAL_LOCALS);
isModified |= isModified(myCbGenerateFinalParameters, settings.GENERATE_FINAL_PARAMETERS);
isModified |= isModified(myCbUseExternalAnnotations, settings.USE_EXTERNAL_ANNOTATIONS);
isModified |= isModified(myInsertOverrideAnnotationCheckBox, settings.INSERT_OVERRIDE_ANNOTATION);
isModified |= isModified(myRepeatSynchronizedCheckBox, settings.REPEAT_SYNCHRONIZED);
isModified |= myMembersOrderList.isModified(settings);
isModified |= !settings.VISIBILITY.equals(myJavaVisibilityPanel.getVisibility());
return isModified;
}
public boolean isModified() {
return isModified(mySettings);
}
private static boolean isModified(JCheckBox checkBox, boolean value) {
return checkBox.isSelected() != value;
}
private static boolean isModified(JTextField textField, String value) {
return !textField.getText().trim().equals(value);
}
private static class MembersOrderList extends JBList {
private static abstract class PropertyManager {
public final String myName;
protected PropertyManager(String nameKey) {
myName = ApplicationBundle.message(nameKey);
}
abstract void apply(CodeStyleSettings settings, int value);
abstract int getValue(CodeStyleSettings settings);
}
private static final Map PROPERTIES = new HashMap();
static {
init();
}
private final DefaultListModel myModel;
public MembersOrderList() {
myModel = new DefaultListModel();
setModel(myModel);
setVisibleRowCount(PROPERTIES.size());
}
public void reset(final CodeStyleSettings settings) {
myModel.removeAllElements();
for (String string : getPropertyNames(settings)) {
myModel.addElement(string);
}
setSelectedIndex(0);
}
private static void init() {
PropertyManager staticFieldManager = new PropertyManager("listbox.members.order.static.fields") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.STATIC_FIELDS_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.STATIC_FIELDS_ORDER_WEIGHT;
}
};
PROPERTIES.put(staticFieldManager.myName, staticFieldManager);
PropertyManager instanceFieldManager = new PropertyManager("listbox.members.order.fields") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.FIELDS_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.FIELDS_ORDER_WEIGHT;
}
};
PROPERTIES.put(instanceFieldManager.myName, instanceFieldManager);
PropertyManager constructorManager = new PropertyManager("listbox.members.order.constructors") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.CONSTRUCTORS_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.CONSTRUCTORS_ORDER_WEIGHT;
}
};
PROPERTIES.put(constructorManager.myName, constructorManager);
PropertyManager staticMethodManager = new PropertyManager("listbox.members.order.static.methods") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.STATIC_METHODS_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.STATIC_METHODS_ORDER_WEIGHT;
}
};
PROPERTIES.put(staticMethodManager.myName, staticMethodManager);
PropertyManager instanceMethodManager = new PropertyManager("listbox.members.order.methods") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.METHODS_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.METHODS_ORDER_WEIGHT;
}
};
PROPERTIES.put(instanceMethodManager.myName, instanceMethodManager);
PropertyManager staticInnerClassManager = new PropertyManager("listbox.members.order.inner.static.classes") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.STATIC_INNER_CLASSES_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.STATIC_INNER_CLASSES_ORDER_WEIGHT;
}
};
PROPERTIES.put(staticInnerClassManager.myName, staticInnerClassManager);
PropertyManager innerClassManager = new PropertyManager("listbox.members.order.inner.classes") {
@Override void apply(CodeStyleSettings settings, int value) {
settings.INNER_CLASSES_ORDER_WEIGHT = value;
}
@Override int getValue(CodeStyleSettings settings) {
return settings.INNER_CLASSES_ORDER_WEIGHT;
}
};
PROPERTIES.put(innerClassManager.myName, innerClassManager);
}
private static Iterable getPropertyNames(final CodeStyleSettings settings) {
List result = new ArrayList(PROPERTIES.keySet());
Collections.sort(result, new Comparator() {
public int compare(String o1, String o2) {
int weight1 = getWeight(o1);
int weight2 = getWeight(o2);
return weight1 - weight2;
}
private int getWeight(String o) {
PropertyManager propertyManager = PROPERTIES.get(o);
if (propertyManager == null) {
throw new IllegalArgumentException("unexpected " + o);
}
return propertyManager.getValue(settings);
}
});
return result;
}
public void apply(CodeStyleSettings settings) {
for (int i = 0; i < myModel.size(); i++) {
Object o = myModel.getElementAt(i);
if (o == null) {
throw new IllegalArgumentException("unexpected " + o);
}
PropertyManager propertyManager = PROPERTIES.get(o.toString());
if (propertyManager == null) {
throw new IllegalArgumentException("unexpected " + o);
}
propertyManager.apply(settings, i + 1);
}
}
public boolean isModified(CodeStyleSettings settings) {
Iterable oldProperties = getPropertyNames(settings);
int i = 0;
for (String property : oldProperties) {
if (i >= myModel.size() || !property.equals(myModel.getElementAt(i))) {
return true;
}
i++;
}
return false;
}
}
}