import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage;
import java.io.IOException;
-import java.util.ArrayList;
-import java.util.HashMap;
import java.util.List;
-import java.util.Map;
import javax.swing.BoxLayout;
import javax.swing.ImageIcon;
+ "zhT8sfdKeehWkUQAeJ7WcH23xTz1uPBwf1hclA3mBZjPojFOIOSsVPpmN1OznfpA+Gn+2kCHqg/d"
+ "LhIA/AFU5d0V6gTjtQAAAABJRU5ErkJggg==";
- /** The original value before current changes. */
- private Object orig;
- private List<Object> origs = new ArrayList<Object>();
- private List<Integer> dirtyBits;
-
- /** The fields (one for non-array, a list for arrays). */
- private JComponent field;
- private List<JComponent> fields = new ArrayList<JComponent>();
-
- /** The fields to panel map to get the actual item added to 'main'. */
- private Map<Integer, JComponent> itemFields = new HashMap<Integer, JComponent>();
+ /** The code base */
+ private final ConfigItemBase<JComponent, E> base;
/** The main panel with all the fields in it. */
private JPanel main;
- /** The {@link MetaInfo} linked to the field. */
- protected MetaInfo<E> info;
+ /**
+ * Prepare a new {@link ConfigItem} instance, linked to the given
+ * {@link MetaInfo}.
+ *
+ * @param info
+ * the info
+ * @param autoDirtyHandling
+ * TRUE to automatically manage the setDirty/Save operations,
+ * FALSE if you want to do it yourself via
+ * {@link ConfigItem#setDirtyItem(int)}
+ */
+ protected ConfigItem(MetaInfo<E> info, boolean autoDirtyHandling) {
+ base = new ConfigItemBase<JComponent, E>(info, autoDirtyHandling) {
+ @Override
+ protected JComponent createEmptyField(int item) {
+ return ConfigItem.this.createEmptyField(item);
+ }
+
+ @Override
+ protected Object getFromInfo(int item) {
+ return ConfigItem.this.getFromInfo(item);
+ }
+
+ @Override
+ protected void setToInfo(Object value, int item) {
+ ConfigItem.this.setToInfo(value, item);
+ }
+
+ @Override
+ protected Object getFromField(int item) {
+ return ConfigItem.this.getFromField(item);
+ }
+
+ @Override
+ protected void setToField(Object value, int item) {
+ ConfigItem.this.setToField(value, item);
+ }
+
+ @Override
+ public JComponent createField(int item) {
+ JComponent field = super.createField(item);
+
+ int height = Math.max(getMinimumHeight(),
+ field.getMinimumSize().height);
+ field.setPreferredSize(new Dimension(200, height));
+
+ return field;
+ }
+
+ @Override
+ public List<JComponent> reload() {
+ List<JComponent> removed = base.reload();
+ if (!removed.isEmpty()) {
+ for (JComponent c : removed) {
+ main.remove(c);
+ }
+ main.revalidate();
+ main.repaint();
+ }
+
+ return removed;
+ }
+
+ @Override
+ protected JComponent removeItem(int item) {
+ JComponent removed = super.removeItem(item);
+ main.remove(removed);
+ main.revalidate();
+ main.repaint();
+
+ return removed;
+ }
+ };
+ }
/**
* Create a new {@link ConfigItem} for the given {@link MetaInfo}.
* different horisontal position)
*/
public void init(int nhgap) {
- if (info.isArray()) {
+ if (getInfo().isArray()) {
this.setLayout(new BorderLayout());
add(label(nhgap), BorderLayout.WEST);
main = new JPanel();
main.setLayout(new BoxLayout(main, BoxLayout.Y_AXIS));
- int size = info.getListSize(false);
+ int size = getInfo().getListSize(false);
for (int i = 0; i < size; i++) {
- addItem(i);
+ addItemWithMinusPanel(i);
}
main.revalidate();
main.repaint();
add.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
- addItem(fields.size());
+ addItemWithMinusPanel(base.getFieldsSize());
main.revalidate();
main.repaint();
}
this.setLayout(new BorderLayout());
add(label(nhgap), BorderLayout.WEST);
- JComponent field = createField(-1);
+ JComponent field = base.createField(-1);
add(field, BorderLayout.CENTER);
}
}
- private void addItem(final int item) {
- JPanel minusPanel = new JPanel(new BorderLayout());
- itemFields.put(item, minusPanel);
+ /** The {@link MetaInfo} linked to the field. */
+ public MetaInfo<E> getInfo() {
+ return base.getInfo();
+ }
+
+ /**
+ * Retrieve the associated graphical component that was created with
+ * {@link ConfigItemBase#createEmptyField(int)}.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the graphical component
+ */
+ protected JComponent getField(int item) {
+ return base.getField(item);
+ }
+
+ /**
+ * Manually specify that the given item is "dirty" and thus should be saved
+ * when asked.
+ * <p>
+ * Has no effect if the class is using automatic dirty handling (see
+ * {@link ConfigItemBase#ConfigItem(MetaInfo, boolean)}).
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ */
+ protected void setDirtyItem(int item) {
+ base.setDirtyItem(item);
+ }
+
+ /**
+ * Check if the value changed since the last load/save into the linked
+ * {@link MetaInfo}.
+ * <p>
+ * Note that we consider NULL and an Empty {@link String} to be equals.
+ *
+ * @param value
+ * the value to test
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return TRUE if it has
+ */
+ protected boolean hasValueChanged(Object value, int item) {
+ return base.hasValueChanged(value, item);
+ }
+
+ private void addItemWithMinusPanel(int item) {
+ JPanel minusPanel = createMinusPanel(item);
+ JComponent field = base.addItem(item, minusPanel);
+ minusPanel.add(field, BorderLayout.CENTER);
+ }
- JComponent field = createField(item);
+ private JPanel createMinusPanel(final int item) {
+ JPanel minusPanel = new JPanel(new BorderLayout());
final JButton remove = new JButton();
setImage(remove, img64remove, "-");
remove.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
- removeItem(item);
+ base.removeItem(item);
}
});
- minusPanel.add(field, BorderLayout.CENTER);
minusPanel.add(remove, BorderLayout.EAST);
main.add(minusPanel);
main.revalidate();
main.repaint();
- }
-
- private void removeItem(int item) {
- int last = itemFields.size() - 1;
-
- for (int i = item; i <= last; i++) {
- Object value = null;
- if (i < last) {
- value = getFromField(i + 1);
- }
- setToField(value, i);
- setToInfo(value, i);
- setDirtyItem(i);
- }
-
- main.remove(itemFields.remove(last));
- main.revalidate();
- main.repaint();
- }
- /**
- * Prepare a new {@link ConfigItem} instance, linked to the given
- * {@link MetaInfo}.
- *
- * @param info
- * the info
- * @param autoDirtyHandling
- * TRUE to automatically manage the setDirty/Save operations,
- * FALSE if you want to do it yourself via
- * {@link ConfigItem#setDirtyItem(int)}
- */
- protected ConfigItem(MetaInfo<E> info, boolean autoDirtyHandling) {
- this.info = info;
- if (!autoDirtyHandling) {
- dirtyBits = new ArrayList<Integer>();
- }
+ return minusPanel;
}
/**
*/
abstract protected void setToField(Object value, int item);
- /**
- * Create a new field for the given graphical component at the given index
- * (note that the component is usually created by
- * {@link ConfigItem#createEmptyField(int)}).
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- * @param field
- * the graphical component
- */
- private void setField(int item, JComponent field) {
- if (item < 0) {
- this.field = field;
- return;
- }
-
- for (int i = fields.size(); i <= item; i++) {
- fields.add(null);
- }
-
- fields.set(item, field);
- }
-
- /**
- * Retrieve the associated graphical component that was created with
- * {@link ConfigItem#createEmptyField(int)}.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- *
- * @return the graphical component
- */
- protected JComponent getField(int item) {
- if (item < 0) {
- return field;
- }
-
- if (item < fields.size()) {
- return fields.get(item);
- }
-
- return null;
- }
-
- /**
- * The original value (before any changes to the {@link MetaInfo}) for this
- * item.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- *
- * @return the original value
- */
- private Object getOrig(int item) {
- if (item < 0) {
- return orig;
- }
-
- if (item < origs.size()) {
- return origs.get(item);
- }
-
- return null;
- }
-
- /**
- * The original value (before any changes to the {@link MetaInfo}) for this
- * item.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- * @param value
- * the new original value
- */
- private void setOrig(Object value, int item) {
- if (item < 0) {
- orig = value;
- } else {
- while (item >= origs.size()) {
- origs.add(null);
- }
-
- origs.set(item, value);
- }
- }
-
- /**
- * Manually specify that the given item is "dirty" and thus should be saved
- * when asked.
- * <p>
- * Has no effect if the class is using automatic dirty handling (see
- * {@link ConfigItem#ConfigItem(MetaInfo, boolean)}).
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- */
- protected void setDirtyItem(int item) {
- if (dirtyBits != null) {
- dirtyBits.add(item);
- }
- }
-
- /**
- * Check if the value changed since the last load/save into the linked
- * {@link MetaInfo}.
- * <p>
- * Note that we consider NULL and an Empty {@link String} to be equals.
- *
- * @param value
- * the value to test
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- *
- * @return TRUE if it has
- */
- protected boolean hasValueChanged(Object value, int item) {
- // We consider "" and NULL to be equals
- Object orig = getOrig(item);
- if (orig == null) {
- orig = "";
- }
- return !orig.equals(value == null ? "" : value);
- }
-
- /**
- * Reload the values to what they currently are in the {@link MetaInfo}.
- */
- private void reload() {
- if (info.isArray()) {
- while (!itemFields.isEmpty()) {
- main.remove(itemFields.remove(itemFields.size() - 1));
- }
- main.revalidate();
- main.repaint();
- for (int item = 0; item < info.getListSize(false); item++) {
- reload(item);
- }
- } else {
- reload(-1);
- }
- }
-
- /**
- * Reload the values to what they currently are in the {@link MetaInfo}.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- */
- private void reload(int item) {
- if (item >= 0 && !itemFields.containsKey(item)) {
- addItem(item);
- }
-
- Object value = getFromInfo(item);
- setToField(value, item);
- setOrig(value == null ? "" : value, item);
- }
-
- /**
- * If the item has been modified, set the {@link MetaInfo} to dirty then
- * modify it to, reflect the changes so it can be saved later.
- * <p>
- * This method does <b>not</b> call {@link MetaInfo#save(boolean)}.
- */
- private void save() {
- if (info.isArray()) {
- boolean dirty = itemFields.size() != info.getListSize(false);
- for (int item = 0; item < itemFields.size(); item++) {
- if (getDirtyBit(item)) {
- dirty = true;
- }
- }
-
- if (dirty) {
- info.setDirty();
- info.setString(null, -1);
-
- for (int item = 0; item < itemFields.size(); item++) {
- Object value = null;
- if (getField(item) != null) {
- value = getFromField(item);
- if ("".equals(value)) {
- value = null;
- }
- }
-
- setToInfo(value, item);
- setOrig(value, item);
- }
- }
- } else {
- if (getDirtyBit(-1)) {
- Object value = getFromField(-1);
-
- info.setDirty();
- setToInfo(value, -1);
- setOrig(value, -1);
- }
- }
- }
-
- /**
- * Check if the item is dirty, and clear the dirty bit if set.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- *
- * @return TRUE if it was dirty, FALSE if not
- */
- private boolean getDirtyBit(int item) {
- if (dirtyBits != null) {
- return dirtyBits.remove((Integer) item);
- }
-
- Object value = null;
- if (getField(item) != null) {
- value = getFromField(item);
- }
-
- return hasValueChanged(value, item);
- }
-
- /**
- * Create a new field for the given item.
- *
- * @param item
- * the item number to get for an array of values, or -1 to get
- * the whole value (has no effect if {@link MetaInfo#isArray()}
- * is FALSE)
- *
- * @return the newly created field
- */
- protected JComponent createField(final int item) {
- JComponent field = createEmptyField(item);
- setField(item, field);
- reload(item);
-
- info.addReloadedListener(new Runnable() {
- @Override
- public void run() {
- reload();
- }
- });
- info.addSaveListener(new Runnable() {
- @Override
- public void run() {
- save();
- }
- });
-
- int height = Math
- .max(getMinimumHeight(), field.getMinimumSize().height);
- field.setPreferredSize(new Dimension(200, height));
-
- return field;
- }
-
/**
* Create a label which width is constrained in lock steps.
*
* @return the label
*/
protected JComponent label(int nhgap) {
- final JLabel label = new JLabel(info.getName());
+ final JLabel label = new JLabel(getInfo().getName());
Dimension ps = label.getPreferredSize();
if (ps == null) {
@Override
public void run() {
StringBuilder builder = new StringBuilder();
- String text = (info.getDescription().replace("\\n", "\n"))
+ String text = (getInfo().getDescription().replace("\\n", "\n"))
.trim();
for (String line : StringUtils.justifyText(text, 80,
Alignment.LEFT)) {
builder.append(line);
}
text = builder.toString();
- JOptionPane.showMessageDialog(ConfigItem.this, text,
- info.getName(), JOptionPane.INFORMATION_MESSAGE);
+ JOptionPane.showMessageDialog(ConfigItem.this, text, getInfo()
+ .getName(), JOptionPane.INFORMATION_MESSAGE);
}
};
@Override
protected Object getFromInfo(int item) {
- return info.getBoolean(item, true);
+ return getInfo().getBoolean(item, true);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setBoolean((Boolean) value, item);
+ getInfo().setBoolean((Boolean) value, item);
}
@Override
if (getFromInfo(item) == null) {
System.err
.println("No default value given for BOOLEAN parameter \""
- + info.getName() + "\", we consider it is FALSE");
+ + getInfo().getName()
+ + "\", we consider it is FALSE");
}
return new JCheckBox();
@Override
protected Object getFromInfo(int item) {
- String path = info.getString(item, false);
+ String path = getInfo().getString(item, false);
if (path != null && !path.isEmpty()) {
return new File(path);
}
@Override
protected void setToInfo(Object value, int item) {
- info.setString(((File) value).getPath(), item);
+ getInfo().setString(((File) value).getPath(), item);
}
@Override
@Override
protected Object getFromInfo(int item) {
- return info.getString(item, true);
+ return getInfo().getString(item, true);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setString((String) value, item);
+ getInfo().setString((String) value, item);
}
/**
* @return a colour
*/
private int getFromInfoColor(int item) {
- Integer color = info.getColor(item, true);
+ Integer color = getInfo().getColor(item, true);
if (color == null) {
return new Color(255, 255, 255, 255).getRGB();
}
int icol = getFromInfoColor(item);
Color initialColor = new Color(icol, true);
Color newColor = JColorChooser.showDialog(ConfigItemColor.this,
- info.getName(), initialColor);
+ getInfo().getName(), initialColor);
if (newColor != null) {
- info.setColor(newColor.getRGB(), item);
- field.setText(info.getString(item, false));
- colorWheel.setIcon(getIcon(17, info.getColor(item, true)));
+ getInfo().setColor(newColor.getRGB(), item);
+ field.setText(getInfo().getString(item, false));
+ colorWheel.setIcon(getIcon(17,
+ getInfo().getColor(item, true)));
}
}
});
field.addKeyListener(new KeyAdapter() {
@Override
public void keyTyped(KeyEvent e) {
- info.setString(field.getText() + e.getKeyChar(), item);
+ getInfo().setString(field.getText() + e.getKeyChar(), item);
int color = getFromInfoColor(item);
colorWheel.setIcon(getIcon(17, color));
}
@Override
protected Object getFromInfo(int item) {
- return info.getString(item, false);
+ return getInfo().getString(item, false);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setString((String) value, item);
+ getInfo().setString((String) value, item);
}
// rawtypes for Java 1.6 (and 1.7 ?) support
@Override
protected Object getFromInfo(int item) {
- return info.getInteger(item, true);
+ return getInfo().getInteger(item, true);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setInteger((Integer) value, item);
+ getInfo().setInteger((Integer) value, item);
}
@Override
@Override
protected Object getFromInfo(int item) {
- return info.getString(item, false);
+ return getInfo().getString(item, false);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setString((String) value, item);
+ getInfo().setString((String) value, item);
}
@Override
@Override
protected Object getFromInfo(int item) {
- return info.getString(item, false);
+ return getInfo().getString(item, false);
}
@Override
@Override
protected void setToInfo(Object value, int item) {
- info.setString((String) value, item);
+ getInfo().setString((String) value, item);
}
@Override
--- /dev/null
+package be.nikiroo.utils.ui;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import be.nikiroo.utils.resources.Bundle;
+import be.nikiroo.utils.resources.MetaInfo;
+
+/**
+ * A graphical item that reflect a configuration option from the given
+ * {@link Bundle}.
+ * <p>
+ * This graphical item can be edited, and the result will be saved back into the
+ * linked {@link MetaInfo}; you still have to save the {@link MetaInfo} should
+ * you wish to, of course.
+ *
+ * @author niki
+ *
+ * @param <T>
+ * the graphical base type to use (i.e., T or TWidget)
+ * @param <E>
+ * the type of {@link Bundle} to edit
+ */
+public abstract class ConfigItemBase<T, E extends Enum<E>> {
+ /** The original value before current changes. */
+ private Object orig;
+ private List<Object> origs = new ArrayList<Object>();
+ private List<Integer> dirtyBits;
+
+ /** The fields (one for non-array, a list for arrays). */
+ private T field;
+ private List<T> fields = new ArrayList<T>();
+
+ /** The fields to panel map to get the actual item added to 'main'. */
+ private Map<Integer, T> itemFields = new HashMap<Integer, T>();
+
+ /** The {@link MetaInfo} linked to the field. */
+ private MetaInfo<E> info;
+
+ /** The {@link MetaInfo} linked to the field. */
+ public MetaInfo<E> getInfo() {
+ return info;
+ }
+
+ /**
+ * The number of fields, for arrays.
+ *
+ * @return
+ */
+ public int getFieldsSize() {
+ return fields.size();
+ }
+
+ /**
+ * The number of fields to panel map to get the actual item added to 'main'.
+ */
+ public int getItemFieldsSize() {
+ return itemFields.size();
+ }
+
+ /**
+ * Add a new item in an array-value {@link MetaInfo}.
+ *
+ * @param item
+ * the index of the new item
+ * @param panel
+ * a linked T, if we want to link it into the itemFields (can be
+ * NULL) -- that way, we can get it back later on
+ * {@link ConfigItemBase#removeItem(int)}
+ *
+ * @return the newly created graphical field
+ */
+ public T addItem(final int item, T panel) {
+ if (panel != null) {
+ itemFields.put(item, panel);
+ }
+ return createField(item);
+ }
+
+ /**
+ * The counter-part to {@link ConfigItemBase#addItem(int, Object)}, to
+ * remove a specific item of an array-values {@link MetaInfo}; all the
+ * remaining items will be shifted as required (so, always the last
+ * graphical object will be removed).
+ *
+ * @param item
+ * the index of the item to remove
+ *
+ * @return the linked graphical T to remove if any (always the latest
+ * graphical object if any)
+ */
+ protected T removeItem(int item) {
+ int last = itemFields.size() - 1;
+
+ for (int i = item; i <= last; i++) {
+ Object value = null;
+ if (i < last) {
+ value = getFromField(i + 1);
+ }
+ setToField(value, i);
+ setToInfo(value, i);
+ setDirtyItem(i);
+ }
+
+ return itemFields.remove(last);
+ }
+
+ /**
+ * Prepare a new {@link ConfigItemBase} instance, linked to the given
+ * {@link MetaInfo}.
+ *
+ * @param info
+ * the info
+ * @param autoDirtyHandling
+ * TRUE to automatically manage the setDirty/Save operations,
+ * FALSE if you want to do it yourself via
+ * {@link ConfigItemBase#setDirtyItem(int)}
+ */
+ protected ConfigItemBase(MetaInfo<E> info, boolean autoDirtyHandling) {
+ this.info = info;
+ if (!autoDirtyHandling) {
+ dirtyBits = new ArrayList<Integer>();
+ }
+ }
+
+ /**
+ * Create an empty graphical component to be used later by
+ * {@link ConfigItemBase#createField(int)}.
+ * <p>
+ * Note that {@link ConfigItemBase#reload(int)} will be called after it was
+ * created by {@link ConfigItemBase#createField(int)}.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the graphical component
+ */
+ abstract protected T createEmptyField(int item);
+
+ /**
+ * Get the information from the {@link MetaInfo} in the subclass preferred
+ * format.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the information in the subclass preferred format
+ */
+ abstract protected Object getFromInfo(int item);
+
+ /**
+ * Set the value to the {@link MetaInfo}.
+ *
+ * @param value
+ * the value in the subclass preferred format
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ */
+ abstract protected void setToInfo(Object value, int item);
+
+ /**
+ * The value present in the given item's related field in the subclass
+ * preferred format.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the value present in the given item's related field in the
+ * subclass preferred format
+ */
+ abstract protected Object getFromField(int item);
+
+ /**
+ * Set the value (in the subclass preferred format) into the field.
+ *
+ * @param value
+ * the value in the subclass preferred format
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ */
+ abstract protected void setToField(Object value, int item);
+
+ /**
+ * Create a new field for the given graphical component at the given index
+ * (note that the component is usually created by
+ * {@link ConfigItemBase#createEmptyField(int)}).
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ * @param field
+ * the graphical component
+ */
+ private void setField(int item, T field) {
+ if (item < 0) {
+ this.field = field;
+ return;
+ }
+
+ for (int i = fields.size(); i <= item; i++) {
+ fields.add(null);
+ }
+
+ fields.set(item, field);
+ }
+
+ /**
+ * Retrieve the associated graphical component that was created with
+ * {@link ConfigItemBase#createEmptyField(int)}.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the graphical component
+ */
+ public T getField(int item) {
+ if (item < 0) {
+ return field;
+ }
+
+ if (item < fields.size()) {
+ return fields.get(item);
+ }
+
+ return null;
+ }
+
+ /**
+ * The original value (before any changes to the {@link MetaInfo}) for this
+ * item.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the original value
+ */
+ private Object getOrig(int item) {
+ if (item < 0) {
+ return orig;
+ }
+
+ if (item < origs.size()) {
+ return origs.get(item);
+ }
+
+ return null;
+ }
+
+ /**
+ * The original value (before any changes to the {@link MetaInfo}) for this
+ * item.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ * @param value
+ * the new original value
+ */
+ private void setOrig(Object value, int item) {
+ if (item < 0) {
+ orig = value;
+ } else {
+ while (item >= origs.size()) {
+ origs.add(null);
+ }
+
+ origs.set(item, value);
+ }
+ }
+
+ /**
+ * Manually specify that the given item is "dirty" and thus should be saved
+ * when asked.
+ * <p>
+ * Has no effect if the class is using automatic dirty handling (see
+ * {@link ConfigItemBase#ConfigItem(MetaInfo, boolean)}).
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ */
+ public void setDirtyItem(int item) {
+ if (dirtyBits != null) {
+ dirtyBits.add(item);
+ }
+ }
+
+ /**
+ * Check if the value changed since the last load/save into the linked
+ * {@link MetaInfo}.
+ * <p>
+ * Note that we consider NULL and an Empty {@link String} to be equals.
+ *
+ * @param value
+ * the value to test
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return TRUE if it has
+ */
+ public boolean hasValueChanged(Object value, int item) {
+ // We consider "" and NULL to be equals
+ Object orig = getOrig(item);
+ if (orig == null) {
+ orig = "";
+ }
+ return !orig.equals(value == null ? "" : value);
+ }
+
+ /**
+ * Reload the values to what they currently are in the {@link MetaInfo}.
+ *
+ * @return for arrays, the list of graphical T objects we don't need any
+ * more (never NULL, but can be empty)
+ */
+ public List<T> reload() {
+ List<T> removed = new ArrayList<T>();
+ if (info.isArray()) {
+ while (!itemFields.isEmpty()) {
+ removed.add(itemFields.remove(itemFields.size() - 1));
+ }
+ for (int item = 0; item < info.getListSize(false); item++) {
+ reload(item);
+ }
+ } else {
+ reload(-1);
+ }
+
+ return removed;
+ }
+
+ /**
+ * Reload the values to what they currently are in the {@link MetaInfo}.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ */
+ private void reload(int item) {
+ if (item >= 0 && !itemFields.containsKey(item)) {
+ addItem(item, null);
+ }
+
+ Object value = getFromInfo(item);
+ setToField(value, item);
+ setOrig(value == null ? "" : value, item);
+ }
+
+ /**
+ * If the item has been modified, set the {@link MetaInfo} to dirty then
+ * modify it to, reflect the changes so it can be saved later.
+ * <p>
+ * This method does <b>not</b> call {@link MetaInfo#save(boolean)}.
+ */
+ private void save() {
+ if (info.isArray()) {
+ boolean dirty = itemFields.size() != info.getListSize(false);
+ for (int item = 0; item < itemFields.size(); item++) {
+ if (getDirtyBit(item)) {
+ dirty = true;
+ }
+ }
+
+ if (dirty) {
+ info.setDirty();
+ info.setString(null, -1);
+
+ for (int item = 0; item < itemFields.size(); item++) {
+ Object value = null;
+ if (getField(item) != null) {
+ value = getFromField(item);
+ if ("".equals(value)) {
+ value = null;
+ }
+ }
+
+ setToInfo(value, item);
+ setOrig(value, item);
+ }
+ }
+ } else {
+ if (getDirtyBit(-1)) {
+ Object value = getFromField(-1);
+
+ info.setDirty();
+ setToInfo(value, -1);
+ setOrig(value, -1);
+ }
+ }
+ }
+
+ /**
+ * Check if the item is dirty, and clear the dirty bit if set.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return TRUE if it was dirty, FALSE if not
+ */
+ private boolean getDirtyBit(int item) {
+ if (dirtyBits != null) {
+ return dirtyBits.remove((Integer) item);
+ }
+
+ Object value = null;
+ if (getField(item) != null) {
+ value = getFromField(item);
+ }
+
+ return hasValueChanged(value, item);
+ }
+
+ /**
+ * Create a new field for the given item.
+ *
+ * @param item
+ * the item number to get for an array of values, or -1 to get
+ * the whole value (has no effect if {@link MetaInfo#isArray()}
+ * is FALSE)
+ *
+ * @return the newly created field
+ */
+ public T createField(final int item) {
+ T field = createEmptyField(item);
+ setField(item, field);
+ reload(item);
+
+ info.addReloadedListener(new Runnable() {
+ @Override
+ public void run() {
+ reload();
+ }
+ });
+ info.addSaveListener(new Runnable() {
+ @Override
+ public void run() {
+ save();
+ }
+ });
+
+ return field;
+ }
+}
git://git.nikiroo.be / nikiroo-utils.git / commitdiff