1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
* Copyright (c) 2005 Jet Brains. All Rights Reserved.
*/
package com.intellij.codeInspection.javaDoc;
import com.intellij.codeInspection.InspectionsBundle;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.ui.DocumentAdapter;
import com.intellij.ui.FieldPanel;
import com.intellij.ui.Gray;
import com.intellij.ui.IdeBorderFactory;
import com.intellij.ui.components.JBTabbedPane;
import com.intellij.util.ui.UIUtil;
import org.jetbrains.annotations.NonNls;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.event.DocumentEvent;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Hashtable;
public class JavaDocLocalInspection extends JavaDocLocalInspectionBase {
private static final Logger LOG = Logger.getInstance("com.intellij.codeInspection.javaDoc.JavaDocLocalInspection");
@Override
public JComponent createOptionsPanel() {
return new OptionsPanel();
}
private class OptionsPanel extends JPanel {
private JPanel createOptionsPanel(String[] modifiers, String[] tags, Options options) {
JPanel pane = new JPanel(new GridLayout(1, tags == null ? 1 : 2));
pane.add(createScopePanel(modifiers, options));
if (tags != null) {
pane.add(createTagsPanel(tags, options));
}
pane.validate();
return pane;
}
private JPanel createTagsPanel(String[] tags, Options options) {
JPanel panel = new JPanel(new GridBagLayout());
panel.setBorder(BorderFactory.createCompoundBorder(IdeBorderFactory.createTitledBorder(
InspectionsBundle.message("inspection.javadoc.required.tags.option.title"), true),
BorderFactory.createEmptyBorder(0, 3, 3, 3)));
GridBagConstraints gc = new GridBagConstraints();
gc.weightx = 1;
gc.weighty = 0;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.anchor = GridBagConstraints.NORTHWEST;
for (int i = 0; i < tags.length; i++) {
JCheckBox box = new JCheckBox(tags[i]);
gc.gridy = i;
if (i == tags.length - 1) gc.weighty = 1;
panel.add(box, gc);
box.setSelected(isTagRequired(options, tags[i]));
box.addChangeListener(new MyChangeListener(box, options, tags[i]));
}
return panel;
}
private class MyChangeListener implements ChangeListener {
private final JCheckBox myCheckBox;
private final Options myOptions;
private final String myTagName;
public MyChangeListener(JCheckBox checkBox, Options options, String tagName) {
myCheckBox = checkBox;
myOptions = options;
myTagName = tagName;
}
@Override
public void stateChanged(ChangeEvent e) {
if (myCheckBox.isSelected()) {
if (!isTagRequired(myOptions, myTagName)) {
myOptions.REQUIRED_TAGS += myTagName;
}
}
else {
myOptions.REQUIRED_TAGS = myOptions.REQUIRED_TAGS.replaceAll(myTagName, "");
}
}
}
private JPanel createScopePanel(final String[] modifiers, final Options options) {
JPanel panel = new JPanel(new BorderLayout());
panel.setBorder(BorderFactory.createCompoundBorder(IdeBorderFactory.createTitledBorder(
InspectionsBundle.message("inspection.scope.for.title"), true),
BorderFactory.createEmptyBorder(0, 3, 3, 3)));
final Hashtable<Integer, JComponent> sliderLabels = new Hashtable<Integer, JComponent>();
for (int i = 0; i < modifiers.length; i++) {
sliderLabels.put(i + 1, new JLabel(modifiers[i]));
}
final JSlider slider = new JSlider(SwingConstants.VERTICAL, 1, modifiers.length, 1);
slider.setLabelTable(sliderLabels);
slider.putClientProperty(UIUtil.JSLIDER_ISFILLED, Boolean.TRUE);
slider.setPreferredSize(new Dimension(80, 50));
slider.setPaintLabels(true);
slider.setSnapToTicks(true);
slider.addChangeListener(new ChangeListener() {
@Override
public void stateChanged(ChangeEvent e) {
int value = slider.getValue();
options.ACCESS_JAVADOC_REQUIRED_FOR = modifiers[value - 1];
for (Integer key : sliderLabels.keySet()) {
sliderLabels.get(key).setForeground(key.intValue() <= value ? Color.black : Gray._100);
}
}
});
Color fore = Color.black;
for (int i = 0; i < modifiers.length; i++) {
sliderLabels.get(i + 1).setForeground(fore);
if (modifiers[i].equals(options.ACCESS_JAVADOC_REQUIRED_FOR)) {
slider.setValue(i + 1);
fore = Gray._100;
}
}
panel.add(slider, BorderLayout.WEST);
return panel;
}
public OptionsPanel() {
super(new GridBagLayout());
GridBagConstraints gc = new GridBagConstraints(0, GridBagConstraints.RELATIVE, 2, 1, 1, 0, GridBagConstraints.NORTH, GridBagConstraints.HORIZONTAL, new Insets(0,0,0,0),0,0 );
add(createAdditionalJavadocTagsPanel(), gc);
JTabbedPane tabs = new JBTabbedPane(SwingConstants.BOTTOM);
@NonNls String[] tags = new String[]{"@author", "@version", "@since"};
tabs.add(InspectionsBundle.message("inspection.javadoc.option.tab.title.package"), createOptionsPanel(new String[]{NONE, PUBLIC},
tags,PACKAGE_OPTIONS));
tags = new String[]{"@author", "@version", "@since", "@param"};
tabs.add(InspectionsBundle.message("inspection.javadoc.option.tab.title"), createOptionsPanel(new String[]{NONE, PUBLIC, PACKAGE_LOCAL},
tags,
TOP_LEVEL_CLASS_OPTIONS));
tags = new String[]{"@return", "@param", InspectionsBundle.message("inspection.javadoc.throws.or.exception.option")};
tabs.add(InspectionsBundle.message("inspection.javadoc.option.tab.title.method"), createOptionsPanel(new String[]{NONE, PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE},
tags,
METHOD_OPTIONS));
tabs.add(InspectionsBundle.message("inspection.javadoc.option.tab.title.field"), createOptionsPanel(new String[]{NONE, PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE},
null,
FIELD_OPTIONS));
tabs.add(InspectionsBundle.message("inspection.javadoc.option.tab.title.inner.class"), createOptionsPanel(new String[]{NONE, PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE},
null,
INNER_CLASS_OPTIONS));
add(tabs, gc);
final JCheckBox checkBox = new JCheckBox(InspectionsBundle.message("inspection.javadoc.option.ignore.deprecated"),
IGNORE_DEPRECATED);
checkBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
IGNORE_DEPRECATED = checkBox.isSelected();
}
});
gc.gridwidth = 1;
add(checkBox, gc);
final JCheckBox periodCheckBox = new JCheckBox(InspectionsBundle.message("inspection.javadoc.option.ignore.period"),
IGNORE_JAVADOC_PERIOD);
periodCheckBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
IGNORE_JAVADOC_PERIOD = periodCheckBox.isSelected();
}
});
add(periodCheckBox, gc);
final JCheckBox ignoreDuplicateThrowsCheckBox = new JCheckBox("Ignore duplicate throws tag",
getIgnoreDuplicatedThrows());
ignoreDuplicateThrowsCheckBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
setIgnoreDuplicatedThrows(ignoreDuplicateThrowsCheckBox.isSelected());
}
});
add(ignoreDuplicateThrowsCheckBox, gc);
final JCheckBox ignorePointToItselfCheckBox = new JCheckBox("Ignore javadoc pointing to itself", IGNORE_POINT_TO_ITSELF);
ignorePointToItselfCheckBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
IGNORE_POINT_TO_ITSELF = ignorePointToItselfCheckBox.isSelected();
}
});
add(ignorePointToItselfCheckBox, gc);
final JCheckBox ignoreSimpleAccessorsCheckBox = new JCheckBox("Ignore simple property accessors", myIgnoreSimpleAccessors);
ignoreSimpleAccessorsCheckBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
myIgnoreSimpleAccessors = ignoreSimpleAccessorsCheckBox.isSelected();
}
});
add(ignoreSimpleAccessorsCheckBox, gc);
}
public FieldPanel createAdditionalJavadocTagsPanel(){
FieldPanel additionalTagsPanel = new FieldPanel(InspectionsBundle.message("inspection.javadoc.label.text"), InspectionsBundle.message("inspection.javadoc.dialog.title"), null, null);
additionalTagsPanel.setPreferredSize(new Dimension(150, additionalTagsPanel.getPreferredSize().height));
additionalTagsPanel.getTextField().getDocument().addDocumentListener(new DocumentAdapter() {
@Override
protected void textChanged(DocumentEvent e) {
final Document document = e.getDocument();
try {
final String text = document.getText(0, document.getLength());
if (text != null) {
myAdditionalJavadocTags = text.trim();
}
}
catch (BadLocationException e1) {
LOG.error(e1);
}
}
});
additionalTagsPanel.setText(myAdditionalJavadocTags);
return additionalTagsPanel;
}
}
}
|
