org.trails.descriptor.annotation
Annotation Type PropertyDescriptor


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


Optional Element Summary
 java.lang.String displayName
          Override the default label text
 java.lang.String format
          A format pattern string
 boolean hidden
          Specifies if a property should appear on both edit and list pages
 int index
           
 boolean readOnly
           
 boolean richText
          Specifies if property can contain html.
 boolean searchable
          Specifies if property should appear on search pages
 java.lang.String shortDescription
           
 boolean summary
          Specifies if a property should appear on the list page.
 

summary

public abstract boolean summary
Specifies if a property should appear on the list page.

Returns:
Default:
true

hidden

public abstract boolean hidden
Specifies if a property should appear on both edit and list pages

Returns:
See Also:
IDescriptor.isHidden()
Default:
false

readOnly

public abstract boolean readOnly
Default:
false

searchable

public abstract boolean searchable
Specifies if property should appear on search pages

Returns:
Default:
true

richText

public abstract boolean richText
Specifies if property can contain html.

Returns:
Default:
false

displayName

public abstract java.lang.String displayName
Override the default label text

Returns:
Default:
""

shortDescription

public abstract java.lang.String shortDescription
Default:
""

format

public abstract java.lang.String format
A format pattern string

Returns:
See Also:
SimpleDateFormat, NumberFormat
Default:
"no_format"

index

public abstract int index
Default:
-1


Copyright © 2004-2008. All Rights Reserved.