Constructor Detail

• Property

  public Property​(java.lang.Class<T> valueType)

  Constructor.

  Parameters:

  valueType - type of the property

Method Detail

• getValueType

  public java.lang.Class<T> getValueType​()

  Get the value type. This is the representation class of the property. Remember that e.g. Boolean.class means that values are Boolean objects; to specify the primitive type, use e.g. Boolean.TYPE. In the latter case, getValue() and setValue(T) will still operate on the wrapper object.

  Returns:

  the type

• canRead

  public abstract boolean canRead​()

  Test whether the property is readable.

  Returns:

  true if it is

• getValue

  public abstract T getValue​()
                      throws java.lang.IllegalAccessException,
                             java.lang.reflect.InvocationTargetException

  Get the value.

  Returns:

  the value of the property

  Throws:

  java.lang.IllegalAccessException - cannot access the called method

  java.lang.reflect.InvocationTargetException - an exception during invocation

• canWrite

  public abstract boolean canWrite​()

  Test whether the property is writable.

  Returns:

  true if the read of the value is supported

• setValue

  public abstract void setValue​(T val)
                         throws java.lang.IllegalAccessException,
                                java.lang.IllegalArgumentException,
                                java.lang.reflect.InvocationTargetException

  Set the value.

  Parameters:

  val - the new value of the property

  Throws:

  java.lang.IllegalAccessException - cannot access the called method

  java.lang.IllegalArgumentException - wrong argument

  java.lang.reflect.InvocationTargetException - an exception during invocation

• supportsDefaultValue

  public boolean supportsDefaultValue​()

  Test whether the property had a default value.

  Returns:

  true if it does (false by default)

• restoreDefaultValue

  public void restoreDefaultValue​()
                           throws java.lang.IllegalAccessException,
                                  java.lang.reflect.InvocationTargetException

  Restore this property to its default value, if supported. In the default implementation, does nothing. Typically you would just call e.g. setValue(default). Note that it is not permitted for this call to throw IllegalArgumentException, though the other two exceptions from setValue(T) may be passed through.

  Throws:

  java.lang.IllegalAccessException - cannot access the called method

  java.lang.reflect.InvocationTargetException - an exception during invocation

• isDefaultValue

  public boolean isDefaultValue​()

  This method indicates whether the current value is the same as the value that would otherwise be restored by calling restoreDefaultValue() (if supportsDefaultValue() returns true). The default implementation returns true and it is recommended to also return true when supportsDefaultValue() returns false (if we do not support default value any value can be considered as the default). If supportsDefaultValue() returns false this method will not be called by the default implementation of property sheet.

  Since:

  3.19

• getPropertyEditor

  public java.beans.PropertyEditor getPropertyEditor​()

  Get a property editor for this property. The default implementation uses standard Java PropertyEditorManager. If a property editor is found, its instance is cached using SoftReference. Caching happens per thread - e.g. it is guaranteed that multiple threads accessing the editor will get different instance.

  Returns:

  the property editor, or null if there is no editor

• equals

  public boolean equals​(java.lang.Object property)

  Overrides:

  equals in class java.lang.Object

• hashCode

  public int hashCode​()

  Overrides:

  hashCode in class java.lang.Object

• getHtmlDisplayName

  public java.lang.String getHtmlDisplayName​()

  Return a variant of the display name containing HTML markup conforming to the limited subset of font-markup HTML supported by the lightweight HTML renderer HtmlRenderer (font color, bold, italic and strike-through supported; font colors can be UIManager color keys if they are prefixed with a ! character, i.e. <font color=&'controlShadow'>). Enclosing HTML tags are not needed.

  This method should return either an HTML display name or null; it should not return the non-HTML display name.

  Returns:

  a String containing conformant, legal HTML markup which represents the display name, or null. The default implementation returns null.

  Since:

  4.30

  See Also:

  HtmlRenderer