|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyInfo
Provides property information that is static with respect to a property's exporting class.
Nested Class Summary | |
---|---|
static class |
PropertyInfo.Edit
Describes conditions under which this property should be interactively edited. |
static class |
PropertyInfo.ExpandState
|
Method Summary | |
---|---|
Property |
createHandle(HasProperties host)
Creates a handle to the property for a specified host object. |
boolean |
getAutoWrite()
Returns true if auto-writing is enabled for this property. |
PropertyMode |
getDefaultMode()
Returns the default inheritance mode for the property. |
NumericInterval |
getDefaultNumericRange()
Returns a default numeric range for this property, if any. |
java.lang.Object |
getDefaultValue()
Returns the default value for the property, or Property.VoidValue if there is not default value. |
java.lang.String |
getDescription()
Returns a text description of the property. |
int |
getDimension()
Returns the numeric dimension of this property, or -1 if the property is not numeric or does not have a fixed dimension. |
PropertyInfo.Edit |
getEditing()
Returns information describing the conditions under which this property should be interactively edited. |
java.lang.Class |
getHostClass()
Returns the host class of the property. |
java.lang.String |
getName()
Returns the name of the property. |
boolean |
getNullValueOK()
Returns true if the property value may be null. |
java.lang.String |
getPrintFormat()
Returns a format string used to convert numeric components of the property's value into text. |
java.lang.Class |
getValueClass()
Returns the class type for the property's value. |
PropertyInfo.ExpandState |
getWidgetExpandState()
|
boolean |
hasRestrictedRange()
Returns true if the property has a restricted value range. |
boolean |
isInheritable()
Returns true if the property is a inheritable property. |
boolean |
isReadOnly()
Returns true if the property is read-only. |
boolean |
isSharable()
Returns true if the value of this property is sharable among several hosts. |
java.lang.Object |
scanValue(ReaderTokenizer rtok)
Scans a value of the type associated with the property from a ReaderTokenizer. |
boolean |
valueEqualsDefault(java.lang.Object value)
Returns true if a specified value equals the default value of the property. |
void |
writeValue(java.lang.Object value,
java.io.PrintWriter pw,
NumberFormat fmt)
Writes a value of the type associated with the property out to a PrintWriter. |
Method Detail |
---|
java.lang.String getName()
boolean isReadOnly()
Property.set
method. getAutoWrite
should return
false for read-only properties, since it makes no sense to try to save
such properties in persistent storage.
boolean hasRestrictedRange()
Property.getRange()
method can be used to obtain a Range
object to
determine whether or not a particular value is legal.
boolean getNullValueOK()
java.lang.String getDescription()
java.lang.String getPrintFormat()
java.lang.Class getValueClass()
java.lang.Class getHostClass()
boolean getAutoWrite()
PropertyList.writeProps
.
PropertyInfo.Edit getEditing()
PropertyInfo.ExpandState getWidgetExpandState()
java.lang.Object getDefaultValue()
Property.VoidValue
if there is not default value.
NumericInterval getDefaultNumericRange()
If a getRangeMethod
is not defined for the property, and
the property has a numeric type, then the default numeric range is
returned by the property's
getRange
method. The
default numeric range is also used to determine bounds on slider widgets
for manipulating the property's value, in case the upper or lower limits
returned by the getRange
method are unbounded.
void writeValue(java.lang.Object value, java.io.PrintWriter pw, NumberFormat fmt) throws java.io.IOException
value
- value to be writtenpw
- PrintWriter to which value is writtenfmt
- Numeric formatting information. This is only used when the value to be
writtem is itself Scannable
, in which case
it is passed to that value's write
method.
java.io.IOException
- if an I/O error occurred, or the value has a type which PropertyInfo does
not know aboutjava.lang.Object scanValue(ReaderTokenizer rtok) throws java.io.IOException
rtok
- ReaderTokenizer supplying input tokens used to specify the property value
java.io.IOException
- if the input is not in the correct format, an I/O error occurred, or the
value has a type which PropertyInfo does not know aboutProperty createHandle(HasProperties host)
getHostClass
).
java.lang.IllegalArgumentException
- if the host does not export the specified propertyboolean valueEqualsDefault(java.lang.Object value)
value
- value to check against the default
boolean isInheritable()
inheritable
property.
PropertyMode getDefaultMode()
int getDimension()
boolean isSharable()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |