Class TimePeriodStringPropertyEditor
- java.lang.Object
-
- org.pentaho.reporting.engine.classic.extensions.legacy.charts.propertyeditor.TimePeriodStringPropertyEditor
-
- All Implemented Interfaces:
PropertyEditor
public class TimePeriodStringPropertyEditor extends Object implements PropertyEditor
A property editor for the deprecated
-
-
Field Summary
Fields Modifier and Type Field Description static StringDAY_PERIOD_TYPE_STRstatic StringFIXEDMILLISECOND_PERIOD_TYPE_STRstatic StringHOUR_PERIOD_TYPE_STRstatic StringMILLISECOND_PERIOD_TYPE_STRstatic StringMINUTE_PERIOD_TYPE_STRstatic StringMONTH_PERIOD_TYPE_STRstatic StringQUARTER_PERIOD_TYPE_STRstatic StringSECOND_PERIOD_TYPE_STRstatic StringWEEK_PERIOD_TYPE_STRstatic StringYEAR_PERIOD_TYPE_STR
-
Constructor Summary
Constructors Constructor Description TimePeriodStringPropertyEditor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPropertyChangeListener(PropertyChangeListener listener)Register a listener for the PropertyChange event.StringgetAsText()Gets the property value as text.ComponentgetCustomEditor()A PropertyEditor may choose to make available a full custom Component that edits its property value.StringgetJavaInitializationString()Returns a fragment of Java code that can be used to set a property to match the editors current state.String[]getTags()If the property value must be one of a set of known tagged values, then this method should return an array of the tags.ObjectgetValue()Gets the property value.booleanisPaintable()Determines whether this property editor is paintable.voidpaintValue(Graphics gfx, Rectangle box)Paint a representation of the value into a given area of screen real estate.voidremovePropertyChangeListener(PropertyChangeListener listener)Remove a listener for the PropertyChange event.voidsetAsText(String text)Set the property value by parsing a given String.voidsetValue(Object value)Set (or change) the object that is to be edited.booleansupportsCustomEditor()Determines whether this property editor supports a custom editor.
-
-
-
Field Detail
-
DAY_PERIOD_TYPE_STR
public static final String DAY_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
FIXEDMILLISECOND_PERIOD_TYPE_STR
public static final String FIXEDMILLISECOND_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
HOUR_PERIOD_TYPE_STR
public static final String HOUR_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
MILLISECOND_PERIOD_TYPE_STR
public static final String MILLISECOND_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
MINUTE_PERIOD_TYPE_STR
public static final String MINUTE_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
MONTH_PERIOD_TYPE_STR
public static final String MONTH_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
QUARTER_PERIOD_TYPE_STR
public static final String QUARTER_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
SECOND_PERIOD_TYPE_STR
public static final String SECOND_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
WEEK_PERIOD_TYPE_STR
public static final String WEEK_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
YEAR_PERIOD_TYPE_STR
public static final String YEAR_PERIOD_TYPE_STR
- See Also:
- Constant Field Values
-
-
Method Detail
-
setValue
public void setValue(Object value)
Set (or change) the object that is to be edited. Primitive types such as "int" must be wrapped as the corresponding object type such as "java.lang.Integer".- Specified by:
setValuein interfacePropertyEditor- Parameters:
value- The new target object to be edited. Note that this object should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold any modified value.
-
getValue
public Object getValue()
Gets the property value.- Specified by:
getValuein interfacePropertyEditor- Returns:
- The value of the property. Primitive types such as "int" will be wrapped as the corresponding object type such as "java.lang.Integer".
-
isPaintable
public boolean isPaintable()
Determines whether this property editor is paintable.- Specified by:
isPaintablein interfacePropertyEditor- Returns:
- True if the class will honor the paintValue method.
-
paintValue
public void paintValue(Graphics gfx, Rectangle box)
Paint a representation of the value into a given area of screen real estate. Note that the propertyEditor is responsible for doing its own clipping so that it fits into the given rectangle. If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop. The given Graphics object will have the default font, color, etc of the parent container. The PropertyEditor may change graphics attributes such as font and color and doesn't need to restore the old values.- Specified by:
paintValuein interfacePropertyEditor- Parameters:
gfx- Graphics object to paint into.box- Rectangle within graphics object into which we should paint.
-
getJavaInitializationString
public String getJavaInitializationString()
Returns a fragment of Java code that can be used to set a property to match the editors current state. This method is intended for use when generating Java code to reflect changes made through the property editor. The code fragment should be context free and must be a legal Java expression as specified by the JLS. Specifically, if the expression represents a computation then all classes and static members should be fully qualified. This rule applies to constructors, static methods and non primitive arguments. Caution should be used when evaluating the expression as it may throw exceptions. In particular, code generators must ensure that generated code will compile in the presence of an expression that can throw checked exceptions. Example results are:- Primitive expresssion:
2 - Class constructor:
new java.awt.Color(127,127,34) - Static field:
java.awt.Color.orange - Static method:
javax.swing.Box.createRigidArea(new java.awt.Dimension(0, 5))
- Specified by:
getJavaInitializationStringin interfacePropertyEditor- Returns:
- a fragment of Java code representing an initializer for the current value. It should not contain a
semi-colon ('
;') to end the expression.
- Primitive expresssion:
-
getAsText
public String getAsText()
Gets the property value as text.- Specified by:
getAsTextin interfacePropertyEditor- Returns:
- The property value as a human editable string.
Returns null if the value can't be expressed as an editable string.
If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().
-
setAsText
public void setAsText(String text) throws IllegalArgumentException
Set the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text.- Specified by:
setAsTextin interfacePropertyEditor- Parameters:
text- The string to be parsed.- Throws:
IllegalArgumentException
-
getTags
public String[] getTags()
If the property value must be one of a set of known tagged values, then this method should return an array of the tags. This can be used to represent (for example) enum values. If a PropertyEditor supports tags, then it should support the use of setAsText with a tag value as a way of setting the value and the use of getAsText to identify the current value.- Specified by:
getTagsin interfacePropertyEditor- Returns:
- The tag values for this property. May be null if this property cannot be represented as a tagged value.
-
getCustomEditor
public Component getCustomEditor()
A PropertyEditor may choose to make available a full custom Component that edits its property value. It is the responsibility of the PropertyEditor to hook itself up to its editor Component itself and to report property value changes by firing a PropertyChange event. The higher-level code that calls getCustomEditor may either embed the Component in some larger property sheet, or it may put it in its own individual dialog, or ...- Specified by:
getCustomEditorin interfacePropertyEditor- Returns:
- A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.
-
supportsCustomEditor
public boolean supportsCustomEditor()
Determines whether this property editor supports a custom editor.- Specified by:
supportsCustomEditorin interfacePropertyEditor- Returns:
- True if the propertyEditor can provide a custom editor.
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Register a listener for the PropertyChange event. When a PropertyEditor changes its value it should fire a PropertyChange event on all registered PropertyChangeListeners, specifying the null value for the property name and itself as the source.- Specified by:
addPropertyChangeListenerin interfacePropertyEditor- Parameters:
listener- An object to be invoked when a PropertyChange event is fired.
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a listener for the PropertyChange event.- Specified by:
removePropertyChangeListenerin interfacePropertyEditor- Parameters:
listener- The PropertyChange listener to be removed.
-
-