com.mizar.annotations
Annotation Type FormField


@Retention(value=RUNTIME)
public @interface FormField

The FormField annotation is optional following the configuration by exception prototcol. If it is not preseent the label will default to the property name de-camel-cased. E.g. housingCosts => Housing Costs

See Also:
FieldInfo

Optional Element Summary
 int compareType
          May be one of the following: FormField.EQUAL FormField.NOT FormField.GREATER_THAN FormField.LESS_THAN FormField.ANY
 java.lang.String desc
           
 boolean display
           
 boolean editable
           
 java.lang.String group
           
 boolean ignoreNulls
           
 boolean isAverageTally
          We normall assume that all properties are counts and can be added freely.
 java.lang.String label
           
 int order
           
 java.lang.String selectProperty
          Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.
 boolean skipRemaining
           
 boolean traverse
          We normally skip over any property that is not a sub class of Number or CharSequence but we might want to label our own properties if they are entities.
 

label

public abstract java.lang.String label
Returns:
the label to use when presenting the value of the property
Default:
""

desc

public abstract java.lang.String desc
Returns:
a description to use a fly-over tip
Default:
""

group

public abstract java.lang.String group
Returns:
the group (or section) the field should appear in
See Also:
FormSections
Default:
""

selectProperty

public abstract java.lang.String selectProperty
Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.

Returns:
the property name to select if it is not this property.
Default:
""

display

public abstract boolean display
Returns:
true, if the field is displayed (defaults to true)
Default:
true

editable

public abstract boolean editable
Returns:
true, if the field is editable (defaults to true)
Default:
true

ignoreNulls

public abstract boolean ignoreNulls
Returns:
true, if null values should be ignored (not displayed) (defaults to true)
Default:
true

compareType

public abstract int compareType
May be one of the following:

Returns:
default compare type to use when building queries.
Default:
1

order

public abstract int order
Returns:
the order to present the field in (defaults to order as found in bean).
Default:
-1

skipRemaining

public abstract boolean skipRemaining
Returns:
true if all remaining properties are to be treated as display=false
Default:
false

traverse

public abstract boolean traverse
We normally skip over any property that is not a sub class of Number or CharSequence but we might want to label our own properties if they are entities.

Returns:
true if property is another entity class with labeled properties
Default:
false

isAverageTally

public abstract boolean isAverageTally
We normall assume that all properties are counts and can be added freely. But some properties are averages, percents or densities that cannot be directly added

Returns:
Default:
false