com.threerings.editor
Annotation Type Editable


@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface Editable

Flags a field or getter/setter method as an editable property.


Optional Element Summary
 String category
          The category under which property falls (empty string for the default category).
 boolean column
          Whether or not this property should be displayed as a column when editing in table mode.
 String[] depends
          The names of any properties upon whose values this property depends.
 String editor
          The custom editor to use (empty string for the default editor for the type).
 int height
          For string properties, the number of rows in the text editor.
 String hgroup
          Neighboring properties with the same hgroup will be grouped into horizontal sublayouts.
 double max
          For numeric properties, the maximum value.
 int maxsize
          For list and array properties, the maximum size.
 double min
          For numeric properties, the minimum value.
 int minsize
          For list and array properties, the minimum size.
 String mode
          Generic editing "mode" whose interpretation depends on the editor.
 boolean nullable
          For object properties, whether or not the property can be null.
 double scale
          For numeric properties, the value scale.
 double step
          For numeric properties, the step size.
 String units
          A translatable string describing the units of the property, if any.
 double weight
          The weight used to determine the display order.
 int width
          For string properties, the width of the text editor.
 

category

public abstract String category
The category under which property falls (empty string for the default category).

Default:
""

weight

public abstract double weight
The weight used to determine the display order.

Default:
0.0

hgroup

public abstract String hgroup
Neighboring properties with the same hgroup will be grouped into horizontal sublayouts.

Default:
""

depends

public abstract String[] depends
The names of any properties upon whose values this property depends.

Default:
{}

editor

public abstract String editor
The custom editor to use (empty string for the default editor for the type).

Default:
""

mode

public abstract String mode
Generic editing "mode" whose interpretation depends on the editor.

Default:
""

column

public abstract boolean column
Whether or not this property should be displayed as a column when editing in table mode.

Default:
false

units

public abstract String units
A translatable string describing the units of the property, if any.

Default:
""

width

public abstract int width
For string properties, the width of the text editor.

Default:
10

height

public abstract int height
For string properties, the number of rows in the text editor.

Default:
1

min

public abstract double min
For numeric properties, the minimum value.

Default:
-1.7976931348623157E308

max

public abstract double max
For numeric properties, the maximum value.

Default:
1.7976931348623157E308

step

public abstract double step
For numeric properties, the step size.

Default:
1.0

scale

public abstract double scale
For numeric properties, the value scale.

Default:
1.0

minsize

public abstract int minsize
For list and array properties, the minimum size.

Default:
0

maxsize

public abstract int maxsize
For list and array properties, the maximum size.

Default:
2147483647

nullable

public abstract boolean nullable
For object properties, whether or not the property can be null.

Default:
false


Copyright © 2011. All Rights Reserved.