/*
* This file is part of LCMC
*
* Copyright (C) 2012, Rastislav Levrinc.
*
* LCMC is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* DRBD Management Console 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with drbd; see the file COPYING. If not, write to
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
*/
package lcmc.cluster.ui.widget;
import java.awt.Color;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.ItemListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.swing.ComboBoxEditor;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.event.DocumentListener;
import javax.swing.text.AbstractDocument;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import lcmc.common.domain.AccessMode;
import lcmc.common.domain.StringValue;
import lcmc.common.domain.Value;
import lcmc.common.ui.utils.MyButton;
import lcmc.common.ui.utils.PatternDocument;
import lcmc.common.domain.util.Tools;
import lcmc.common.ui.utils.SwingUtils;
import lcmc.common.ui.utils.WidgetListener;
/**
* An implementation of a field where user can enter new value. The
* field can be Textfield or combo box, depending if there are values
* too choose from.
*/
@Named
public final class ComboBox extends GenericWidget<MComboBox<Value>> {
private static final int CB_SCROLLBAR_MAX_ROWS = 10;
@Inject
private SwingUtils swingUtils;
protected static Value addItems(final Collection<Value> comboList, final Value selectedValue, final Value[] items) {
Value selectedValueInfo = null;
if (items != null) {
for (final Value item : items) {
if (Tools.areEqual(item, selectedValue)) {
selectedValueInfo = item;
}
comboList.add(item);
}
if (selectedValueInfo == null && selectedValue != null) {
comboList.add(selectedValue);
selectedValueInfo = selectedValue;
}
}
return selectedValueInfo;
}
void init(final Value selectedValue,
final Value[] items,
final String regexp,
final int width,
final Map<String, String> abbreviations,
final AccessMode enableAccessMode,
final MyButton fieldButton) {
super.init(regexp, enableAccessMode, fieldButton);
addComponent(getComboBox(selectedValue, items, regexp, abbreviations), width);
}
/** Returns combo box with items in the combo and selectedValue on top. */
private MComboBox<Value> getComboBox(final Value selectedValue,
final Value[] items,
final String regexp,
final Map<String, String> abbreviations) {
final List<Value> comboList = new ArrayList<Value>();
final Value selectedValueInfo = addItems(comboList, selectedValue, items);
final MComboBox<Value> cb = new MComboBox<Value>(comboList.toArray(new Value[comboList.size()]));
final JTextComponent editor = (JTextComponent) cb.getEditor().getEditorComponent();
if (regexp != null) {
editor.setDocument(new PatternDocument(regexp, abbreviations));
}
cb.setMaximumRowCount(CB_SCROLLBAR_MAX_ROWS);
if (selectedValueInfo != null) {
cb.setSelectedItem(selectedValueInfo);
}
/* workround, so that default button works */
editor.addKeyListener(new ActivateDefaultButtonListener<Value>(cb));
/* removing select... keyword */
editor.addFocusListener(new FocusListener() {
@Override
public void focusGained(final FocusEvent e) {
final Value v = getValue();
if (v == null || v.isNothingSelected()) {
editor.setText("");
}
}
@Override
public void focusLost(final FocusEvent e) {
/* do nothing */
}
});
return cb;
}
private boolean hasComboBoxChanged(final Value[] items) {
final MComboBox<Value> cb = getInternalComponent();
if (items.length != cb.getItemCount()) {
return true;
}
for (int i = 0; i < items.length; i++) {
if (!Tools.areEqual(items[i], cb.getItemAt(i))) {
return true;
}
}
return false;
}
/** Reloads combo box with items and selects supplied value. */
@Override
public void reloadComboBox(final Value selectedValue, final Value[] items) {
swingUtils.invokeLater(new Runnable() {
@Override
public void run() {
final MComboBox<Value> cb = getInternalComponent();
final Object selectedObject = cb.getSelectedItem();
final Value selectedItem;
if (selectedObject instanceof String) {
selectedItem = new StringValue((String) selectedObject);
} else {
selectedItem = (Value) selectedObject;
}
boolean selectedChanged = false;
if (selectedValue == null && selectedItem != null && !selectedItem.isNothingSelected()) {
selectedChanged = true;
} else if (selectedValue != null && !selectedValue.equals(selectedItem)) {
selectedChanged = true;
}
final boolean itemsChanged = hasComboBoxChanged(items);
if (!selectedChanged && !itemsChanged) {
return;
}
cb.setPreferredSize(null);
/* removing dupicates */
final Collection<Value> comboList = new ArrayList<Value>();
final Value selectedValueInfo = addItems(comboList, selectedValue, items);
if (itemsChanged) {
final Collection<Value> itemCache = new HashSet<Value>();
cb.setSelectedIndex(-1);
cb.removeAllItems();
for (final Value item : comboList) {
if (!itemCache.contains(item)) {
cb.addItem(item);
itemCache.add(item);
}
}
}
if (selectedValueInfo != null) {
cb.setSelectedItem(selectedValueInfo);
}
}
});
}
/** Set combo box editable. */
@Override
public void setEditable(final boolean editable) {
super.setEditable(editable);
final JComponent comp = getInternalComponent();
swingUtils.invokeInEdt(new Runnable() {
@Override
public void run() {
final Value v = getValue();
if (isAlwaysEditable()) {
((JComboBox) comp).setEditable(true);
final JTextComponent editor = getTextComponent();
if (v == null || v.isNothingSelected()) {
editor.selectAll();
}
} else {
if (v != null && !v.isNothingSelected()) {
((JComboBox) comp).setEditable(editable);
}
}
}
});
}
/**
* Returns string value. If object value is null, returns empty string (not
* null).
*/
@Override
public String getStringValue() {
final Value v = getValue();
if (v == null || v.isNothingSelected()) {
return "";
}
return v.getValueForConfig();
}
/** Return value, that user have chosen in the field or typed in. */
@Override
protected Value getValueInternal() {
final MComboBox<Value> cb = getInternalComponent();
if (cb.isEditable()) {
final JTextComponent editor = (JTextComponent) cb.getEditor().getEditorComponent();
String text = editor.getText();
if (text == null) {
text = "";
}
final Object comboBoxValue0 = cb.getSelectedItem();
if (comboBoxValue0 instanceof Value) {
final Value comboBoxValue = (Value) comboBoxValue0;
if (text.equals(comboBoxValue.getValueForGui())) {
if (comboBoxValue.isNothingSelected()) {
return null;
}
return comboBoxValue;
}
}
return new StringValue(text);
}
final Value value = (Value) cb.getSelectedItem();
if (value == null || value.isNothingSelected()) {
return null;
}
return value;
}
/** Clears the combo box. */
@Override
public void clear() {
swingUtils.invokeLater(new Runnable() {
@Override
public void run() {
getInternalComponent().removeAllItems();
}
});
}
/** Returns whether component is editable or not. */
@Override
public boolean isEditable() {
return getInternalComponent().isEditable();
}
/** Set item/value in the component and waits till it is set. */
@Override
protected void setValueAndWait0(final Value item) {
swingUtils.isSwingThread();
final MComboBox<Value> cb = getInternalComponent();
if (item == null) {
cb.setSelectedItem(new StringValue());
} else {
cb.setSelectedItem(item);
if (!Tools.areEqual(item, cb.getSelectedItem())) {
setAlwaysEditable(true);
setText(item.getValueForConfig());
}
}
}
@Override
public void setSelectedIndex(final int index) {
final MComboBox<Value> cb = getInternalComponent();
cb.setSelectedIndex(index);
}
@Override
public Document getDocument() {
final JTextComponent tc = getTextComponent();
return tc.getDocument();
}
/** Selects part after first '*' in the ip. */
@Override
public void selectSubnet() {
final JTextComponent tc = getTextComponent();
final String ip = tc.getText();
int p = ip.length() - 2;
while (p >= 0 && Tools.isIp(ip) && ".0".equals(ip.substring(p, p + 2))) {
p -= 2;
}
final int pos = p + 3;
if (pos >= 0 && pos < ip.length()) {
swingUtils.invokeLater(new Runnable() {
@Override
public void run() {
tc.select(pos, ip.length());
}
});
}
}
@Override
public void addListeners(final WidgetListener wl) {
getWidgetListeners().add(wl);
addDocumentListener(getDocument(), wl);
getInternalComponent().addItemListener(getItemListener(wl));
}
@Override
protected void setComponentBackground(final Color backgroundColor, final Color compColor) {
setBackground(Color.WHITE);
}
@Override
public void setBackgroundColor(final Color bg) {
swingUtils.invokeLater(new Runnable() {
@Override
public void run() {
setBackground(bg);
}
});
}
/** Cleanup whatever would cause a leak. */
@Override
public void cleanup() {
getWidgetListeners().clear();
final MComboBox<Value> thisCB = getInternalComponent();
final AbstractDocument dc = (AbstractDocument) getDocument();
for (final DocumentListener dl : dc.getDocumentListeners()) {
dc.removeDocumentListener(dl);
}
for (final ItemListener il : thisCB.getItemListeners()) {
thisCB.removeItemListener(il);
}
}
public JTextComponent getTextComponent() {
final JComponent comp = getInternalComponent();
final ComboBoxEditor editor = ((JComboBox) comp).getEditor();
return (JTextComponent) editor.getEditorComponent();
}
/** Select the text component. */
@Override
public void select(final int selectionStart, final int selectionEnd) {
getTextComponent().select(selectionStart, selectionEnd);
}
@Override
public void selectAll() {
getTextComponent().selectAll();
}
@Override
public void setText(final String text) {
getTextComponent().setText(text);
}
}