-
Notifications
You must be signed in to change notification settings - Fork 2
/
BorderHighlighter.java
257 lines (230 loc) · 7.53 KB
/
BorderHighlighter.java
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/*
* $Id: BorderHighlighter.java 3100 2008-10-14 22:33:10Z rah003 $
*
* Copyright 2007 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.hdesktop.swingx.decorator;
import java.awt.Component;
import javax.swing.BorderFactory;
import javax.swing.JComponent;
import javax.swing.border.Border;
/**
* A Highlighter that applies a border the the renderer component.
*
* The resulting border can be configured to
* - ignore the component's border, set this highlighter's border
* - compound of this highlighter's border and component border, with
* this highlighter's border either inner or outer.
*
* The default setting is compound outer.
*
*/
public class BorderHighlighter extends AbstractHighlighter {
private Border paddingBorder;
private boolean inner;
private boolean compound;
/**
*
* Instantiates a BorderHighlighter with no padding. The
* Highlighter is applied unconditionally.
*
*/
public BorderHighlighter() {
this((HighlightPredicate) null, null);
}
/**
*
* Instantiates a BorderHighlighter with no padding, using the
* given predicate.
*
* @param predicate the HighlightPredicate to use
*
*/
public BorderHighlighter(HighlightPredicate predicate) {
this(predicate, null);
}
/**
*
* Instantiates a BorderHighlighter with the given padding. The
* Highlighter is applied unconditionally.
*
* @param paddingBorder the border to apply as visual decoration.
*
*/
public BorderHighlighter(Border paddingBorder) {
this(null, paddingBorder);
}
/**
*
* Instantiates a BorderHighlighter with the given padding,
* HighlightPredicate and default compound property.
* If the predicate is null, the highlighter
* will be applied unconditionally.
*
* @param predicate the HighlightPredicate to use
* @param paddingBorder the border to apply as visual decoration.
*
*/
public BorderHighlighter(HighlightPredicate predicate, Border paddingBorder) {
this(predicate, paddingBorder, true);
}
/**
*
* Instantiates a BorderHighlighter with the given padding,
* HighlightPredicate, compound property and default inner property.
* If the predicate is null, the highlighter
* will be applied unconditionally.
*
* @param predicate the HighlightPredicate to use
* @param paddingBorder the border to apply as visual decoration.
* @param compound the compound property.
*
*/
public BorderHighlighter(HighlightPredicate predicate,
Border paddingBorder, boolean compound) {
this(predicate, paddingBorder, compound, false);
}
/**
*
* Instantiates a BorderHighlighter with the given padding,
* HighlightPredicate and compound property. If the predicate is null, the highlighter
* will be applied unconditionally.
*
* @param predicate the HighlightPredicate to use
* @param paddingBorder the border to apply as visual decoration.
* @param compound the compound property
* @param inner the inner property
*/
public BorderHighlighter(HighlightPredicate predicate,
Border paddingBorder, boolean compound, boolean inner) {
super(predicate);
this.paddingBorder = paddingBorder;
this.compound = compound;
this.inner = inner;
}
/**
* {@inheritDoc}
*/
@Override
protected Component doHighlight(Component renderer, ComponentAdapter adapter) {
((JComponent) renderer).setBorder(compoundBorder(
((JComponent) renderer).getBorder()));
return renderer;
}
/**
* {@inheritDoc} <p>
*
* Overridden to prevent highlighting if there's no padding available or
* the renderer is not of type JComponent.
*
* @param component the cell renderer component that is to be decorated
* @param adapter the ComponentAdapter for this decorate operation
* @return true padding is available and the
* renderer is a JComponent. False otherwise.
*/
@Override
protected boolean canHighlight(Component component, ComponentAdapter adapter) {
return (getBorder() != null) && (component instanceof JComponent);
}
/**
* Sets the compound property. If true, the highlight border will be compounded
* with the renderer's border, if any. Otherwise, the highlight border will
* replace the renderer's border.<p>
*
* The default value is true;
*
* @param compound a boolean indicating whether the highlight border should be
* compounded with the component's border.
*/
public void setCompound(boolean compound) {
if (isCompound() == compound) return;
this.compound = compound;
fireStateChanged();
}
/**
*
* @return the compound property.
* @see #setCompound(boolean)
*/
public boolean isCompound() {
return compound;
}
/**
* Sets the inner property. If true/false and compounded is enabled
* the highlight border will be the inner/outer border of the compound.
*
* The default value is false;
*
* @param inner a boolean indicating whether the highlight border should be
* compounded as inner or outer border.
*
* @see #isInner()
*/
public void setInner(boolean inner) {
if (isInner() == inner) return;
this.inner = inner;
fireStateChanged();
}
/**
* Returns the inner property.
*
* @return the inner property.
* @see #setInner(boolean)
*/
public boolean isInner() {
return inner;
}
/**
* Sets the Border used for highlighting. <p>
*
* The default value is null.
*
* @param padding the Border to use
*/
public void setBorder(Border padding) {
if (areEqual(padding, getBorder())) return;
this.paddingBorder = padding;
fireStateChanged();
}
/**
* Returns the border used for highlighing.<p>
*
* @return the border used to highlight.
*/
public Border getBorder() {
return paddingBorder;
}
/**
* PRE: paddingBorder != null.
* @param border
* @return
*/
private Border compoundBorder(Border border) {
if (compound) {
if (border != null) {
if (inner) {
return BorderFactory.createCompoundBorder(border,
paddingBorder);
}
return BorderFactory.createCompoundBorder(paddingBorder,
border);
}
}
return paddingBorder;
}
}