Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.gui » config » model » [javadoc | source]
org.jfree.report.modules.gui.config.model
abstract public class: ConfigDescriptionEntry [javadoc | source]
java.lang.Object
   org.jfree.report.modules.gui.config.model.ConfigDescriptionEntry

Direct Known Subclasses:
    TextConfigDescriptionEntry, EnumConfigDescriptionEntry, ClassConfigDescriptionEntry

A config description entry provides a declaration of a single report configuration key and speicifes rules for the values of that key.
Constructor:
 protected ConfigDescriptionEntry(String keyName) 
    Creates a new config description entry with the given name.
    Parameters:
    keyName - the name of the entry.
Method from org.jfree.report.modules.gui.config.model.ConfigDescriptionEntry Summary:
equals,   getDescription,   getKeyName,   hashCode,   isGlobal,   isHidden,   setDescription,   setGlobal,   setHidden
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.modules.gui.config.model.ConfigDescriptionEntry Detail:
 public boolean equals(Object o) 
    Checks whether the given object is equal to this config description entry. The object will be equal, if it is also an config description entry with the same name as this entry.
 public String getDescription() 
    Returns the descrption of the configuration entry.
 public String getKeyName() 
    Returns the full key name of the configuration description.
 public int hashCode() 
    Computes an hashcode for this object.
 public boolean isGlobal() 
    Returns, whether the key is a global key. Global keys are read from the global report configuration and specifying them in the report local configuration is useless.
 public boolean isHidden() 
    Returns, whether the key is hidden. Hidden keys will not be visible in the configuration editor.
 public  void setDescription(String description) 
    Defines the descrption of the configuration entry.
 public  void setGlobal(boolean global) 
    Defines, whether the key is a global key. Global keys are read from the global report configuration and specifying them in the report local configuration is useless.
 public  void setHidden(boolean hidden) 
    Defines, whether the key is hidden. Hidden keys will not be visible in the configuration editor.