protected AbstractKeyEditor(HierarchicalConfiguration config,
    ConfigDescriptionEntry entry) 
{
                                            
    this.resources = new ResourceBundleSupport(ConfigGUIModule.BUNDLE_NAME);
    this.setLayout(new BorderLayout());
    this.config = config;
    this.entry = entry;
    stateLabel = new JLabel(getEmptyIcon());
}

Creates a new key editor for the given report configuration and key entry.

Parameters:

config - the report configuration that supplies the value for the editor

entry - the entry description provides the meta data for the edited key.

 protected  void deleteValue() 
{
    config.setConfigProperty(entry.getKeyName(), null);
}

Removes the value from the configuration; the configuration will fall back to the default value from the global configuration.

Deleting the value triggers the isDefined property.

 public JComponent getComponent() 
{
    return this;
}

Returns the editor component; this implementation returns the "this" reference.

 public Configuration getConfig() 
{
    return config;
}

Returns the report configuration instance used for this editor.

 protected Icon getEmptyIcon() 
{
    if (AbstractKeyEditor.emptyIcon == null)
    {
      final Icon errorIcon = getErrorIcon();
      final int width = errorIcon.getIconWidth();
      final int height = errorIcon.getIconHeight();
      AbstractKeyEditor.emptyIcon = ImageUtils.createTransparentIcon(width, height);
    }
    return AbstractKeyEditor.emptyIcon;
}

Returns the empty icon for this an all derived editors.

 public ConfigDescriptionEntry getEntry() 
{
    return entry;
}

Returns the config description entry of this editor.

 protected Icon getErrorIcon() 
{
    if (AbstractKeyEditor.errorIcon == null)
    {
      AbstractKeyEditor.errorIcon = resources.getIcon("default-editor.error-icon"); //$NON-NLS-1$
    }
    return AbstractKeyEditor.errorIcon;
}

Returns the error icon for this an all derived editors.

 public boolean isDefined() 
{
    return config.isLocallyDefined(entry.getKeyName());
}

Checks whether the local key has a defined value in the local report configuration.

 public boolean isValidInput() 
{
    return validInput;
}

Returns true, if the component validated the entered values, false otherwise.

 protected String loadValue() 
{
    return config.getConfigProperty(entry.getKeyName());
}

Loads the value from the configuration.

 protected  void setContentPane(JPanel contentPane) 
{
    removeAll();
    add(contentPane, BorderLayout.CENTER);
    add(stateLabel, BorderLayout.EAST);
}

Defines the content pane for this editor.

 protected  void setValidInput(boolean validInput) 
{
    if (this.validInput != validInput)
    {
      final boolean oldValue = this.validInput;
      this.validInput = validInput;
      firePropertyChange(AbstractKeyEditor.VALID_INPUT_PROPERTY, oldValue, validInput);
      if (this.validInput == false)
      {
        stateLabel.setIcon(getErrorIcon());
      }
      else
      {
        stateLabel.setIcon(getEmptyIcon());
      }
    }
}

Defines, whether the input is valid. This should be called after the value of the component changed.

 protected  void storeValue(String o) 
{
    config.setConfigProperty(entry.getKeyName(), o);
}

Stores the value to the configuration.