Attribute (Dynamo Framework - API 1.6.3-CB3 API)

```
@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface Attribute
```
An interface that can be used to specify the properties of an attribute - this will override any defaults

Author:

bas.rutten

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String[]`	`allowedExtensions`
`Cascade[]`	`cascade`
`CheckboxMode`	`checkboxMode`
`boolean`	`complexEditable`
`boolean`	`currency`
`AttributeDateType`	`dateType`
`String`	`defaultValue`
`String`	`description`
`boolean`	`directNavigation` Whether direct navigation is allowed to this entity from another entity detailscreen
`String`	`displayFormat`
`String`	`displayName`
`EditableType`	`editable`
`boolean`	`embedded`
`float`	`expansionFactor`
`String`	`falseRepresentation`
`String`	`fileNameProperty`
`String[]`	`groupTogetherWith`
`boolean`	`image`
`boolean`	`main`
`int`	`maxLength`
`int`	`maxLengthInTable`
`long`	`maxValue`
`Class<?>`	`memberType`
`int`	`minLength`
`long`	`minValue`
`boolean`	`multipleSearch`
`boolean`	`navigable`
`NumberSelectMode`	`numberSelectMode`
`boolean`	`percentage`
`int`	`precision`
`String`	`prompt`
`String`	`quickAddPropertyName`
`String`	`replacementSearchPath`
`boolean`	`required`
`boolean`	`requiredForSearching`
`boolean`	`searchable`
`boolean`	`searchCaseSensitive`
`boolean`	`searchForExactValue`
`boolean`	`searchPrefixOnly`
`AttributeSelectMode`	`searchSelectMode`
`AttributeSelectMode`	`selectMode`
`VisibilityType`	`showInTable`
`boolean`	`sortable`
`String`	`styles`
`AttributeTextFieldMode`	`textFieldMode`
`String`	`trueRepresentation` the representation to use instead of "true"
`boolean`	`url` indicates whether this is a clickable URL
`boolean`	`useThousandsGrouping` indicates whether to use thousands grouping for an integer or decimal field
`VisibilityType`	`visible` whether the field is visible
`boolean`	`week` whether the field represents a date that must be shown in week notation

- Element Detail
  - allowedExtensions
```
public abstract String[] allowedExtensions
```
    Returns:
    
    the allowed extensions for a file upload component
    
    Default:
    
    {}
- - cascade
```
public abstract Cascade[] cascade
```
    Returns:
    
    the properties to cascade to when the value of this property changes
    
    Default:
    
    {}
- - checkboxMode
```
public abstract CheckboxMode checkboxMode
```
    Returns:
    
    the desired check box mode
    
    Default:
    
    com.ocs.dynamo.domain.model.CheckboxMode.CHECKBOX
- - complexEditable
```
public abstract boolean complexEditable
```
    Returns:
    
    whether a complex attribute is directly editable
    
    Default:
    
    false
- - currency
```
public abstract boolean currency
```
    Returns:
    
    is this a currency field?
    
    Default:
    
    false
- - dateType
```
public abstract AttributeDateType dateType
```
    Returns:
    
    the date type (date, time, or timestamp)
    
    Default:
    
    com.ocs.dynamo.domain.model.AttributeDateType.INHERIT
- - defaultValue
```
public abstract String defaultValue
```
    Returns:
    
    the default value (represented as a string - use "." as the decimal separator)
    
    Default:
    
    ""
- - description
```
public abstract String description
```
    Returns:
    
    the description (appears as a tooltip)
    
    Default:
    
    ""
- - directNavigation
```
public abstract boolean directNavigation
```
    Whether direct navigation is allowed to this entity from another entity detailscreen
    
    Default:
    
    false
- - displayFormat
```
public abstract String displayFormat
```
    Returns:
    
    the display format (useful in case of dates)
    
    Default:
    
    ""
- - displayName
```
public abstract String displayName
```
    Returns:
    
    the display name
    
    Default:
    
    ""
- - editable
```
public abstract EditableType editable
```
    Returns:
    
    when the field can be edited
    
    Default:
    
    com.ocs.dynamo.domain.model.EditableType.EDITABLE
- - embedded
```
public abstract boolean embedded
```
    Returns:
    
    whether the attribute is embedded
    
    Default:
    
    false
- - expansionFactor
```
public abstract float expansionFactor
```
    Default:
    
    1.0f
- - falseRepresentation
```
public abstract String falseRepresentation
```
    Returns:
    
    the representation to use instead of "false"
    
    Default:
    
    ""
- - fileNameProperty
```
public abstract String fileNameProperty
```
    Returns:
    
    the name of the property in which to store the file name (after an upload)
    
    Default:
    
    ""
- - groupTogetherWith
```
public abstract String[] groupTogetherWith
```
    Returns:
    
    the names of other attributes that appear on the same line as this attribute inside an edit form
    
    Default:
    
    {}
- - image
```
public abstract boolean image
```
    Returns:
    
    whether the component is meant for uploading/displaying images
    
    Default:
    
    false
- - main
```
public abstract boolean main
```
    Returns:
    
    whether this attribute is the main attribute
    
    Default:
    
    false
- - maxLength
```
public abstract int maxLength
```
    Returns:
    
    the maximum element length (-1 indicates no value)
    
    Default:
    
    -1
- - maxLengthInTable
```
public abstract int maxLengthInTable
```
    Returns:
    
    the maximum length of the text representation in a table
    
    Default:
    
    -1
- - maxValue
```
public abstract long maxValue
```
    Returns:
    
    the maximum allowed value of an element in a collection table
    
    Default:
    
    9223372036854775807L
- - memberType
```
public abstract Class<?> memberType
```
    Returns:
    
    the type of the members in a detail collection - needed in very specific cases
    
    Default:
    
    java.lang.Object.class
- - minLength
```
public abstract int minLength
```
    Returns:
    
    the minimum element length (-1 indicates no value)
    
    Default:
    
    -1
- - minValue
```
public abstract long minValue
```
    Returns:
    
    the minimum element length (-1 indicates no value)
    
    Default:
    
    -9223372036854775808L
- - multipleSearch
```
public abstract boolean multipleSearch
```
    Returns:
    
    whether this attribute allows search for multiple values (only for MASTER attributes)
    
    Default:
    
    false
- - navigable
```
public abstract boolean navigable
```
    Returns:
    
    whether this attribute is navigable when inside a table
    
    Default:
    
    false
- - numberSelectMode
```
public abstract NumberSelectMode numberSelectMode
```
    Returns:
    
    the number select mode (indicates which component to use for editing numbers)
    
    Default:
    
    com.ocs.dynamo.domain.model.NumberSelectMode.TEXTFIELD
- - percentage
```
public abstract boolean percentage
```
    Returns:
    
    is the numeric field a percentage
    
    Default:
    
    false
- - precision
```
public abstract int precision
```
    Returns:
    
    the desired decimap precision
    
    Default:
    
    -1
- - prompt
```
public abstract String prompt
```
    Returns:
    
    the prompt value to use in input fields
    
    Default:
    
    ""
- - quickAddPropertyName
```
public abstract String quickAddPropertyName
```
    Returns:
    
    the name of the property to set when using "quick add" functionality
    
    Default:
    
    ""
- - replacementSearchPath
```
public abstract String replacementSearchPath
```
    Returns:
    
    the replacement search path to be used when the property does not directly map to a JPA property
    
    Default:
    
    ""
- - required
```
public abstract boolean required
```
    Returns:
    
    whether the attribute is required
    
    Default:
    
    false
- - requiredForSearching
```
public abstract boolean requiredForSearching
```
    Returns:
    
    whether the attribute is required when performing a search
    
    Default:
    
    false
- - searchable
```
public abstract boolean searchable
```
    Returns:
    
    whether the field is searchable
    
    Default:
    
    false
- - searchCaseSensitive
```
public abstract boolean searchCaseSensitive
```
    Returns:
    
    whether searching is case-sensitive
    
    Default:
    
    false
- - searchForExactValue
```
public abstract boolean searchForExactValue
```
    Returns:
    
    whether to search for an exact match rather than an interval (for integer or date fields)
    
    Default:
    
    false
- - searchPrefixOnly
```
public abstract boolean searchPrefixOnly
```
    Returns:
    
    whether to match on prefix only
    
    Default:
    
    false
- - searchSelectMode
```
public abstract AttributeSelectMode searchSelectMode
```
    Returns:
    
    the selection component to use in search mode
    
    Default:
    
    com.ocs.dynamo.domain.model.AttributeSelectMode.INHERIT
- - selectMode
```
public abstract AttributeSelectMode selectMode
```
    Returns:
    
    the selection component to use in edit mode
    
    Default:
    
    com.ocs.dynamo.domain.model.AttributeSelectMode.INHERIT
- - showInTable
```
public abstract VisibilityType showInTable
```
    Returns:
    
    whether the field shows up in a table
    
    Default:
    
    com.ocs.dynamo.domain.model.VisibilityType.INHERIT
- - sortable
```
public abstract boolean sortable
```
    Returns:
    
    whether a table can be sorted on this field
    
    Default:
    
    true
- - styles
```
public abstract String styles
```
    Returns:
    
    one or more references to styles; in Vaadin used to specify stylenames seperated by space
    
    Default:
    
    ""
- - textFieldMode
```
public abstract AttributeTextFieldMode textFieldMode
```
    Returns:
    
    whether to display a text attribute as a text field or a text area
    
    Default:
    
    com.ocs.dynamo.domain.model.AttributeTextFieldMode.INHERIT
- - trueRepresentation
```
public abstract String trueRepresentation
```
    the representation to use instead of "true"
    
    Default:
    
    ""
- - url
```
public abstract boolean url
```
    indicates whether this is a clickable URL
    
    Default:
    
    false
- - useThousandsGrouping
```
public abstract boolean useThousandsGrouping
```
    indicates whether to use thousands grouping for an integer or decimal field
    
    Default:
    
    true
- - visible
```
public abstract VisibilityType visible
```
    whether the field is visible
    
    Default:
    
    com.ocs.dynamo.domain.model.VisibilityType.INHERIT
- - week
```
public abstract boolean week
```
    whether the field represents a date that must be shown in week notation
    
    Default:
    
    false

Annotation Type Attribute

Optional Element Summary

Element Detail

allowedExtensions

cascade

checkboxMode

complexEditable

currency

dateType

defaultValue

description

directNavigation

displayFormat

displayName

editable

embedded

expansionFactor

falseRepresentation

fileNameProperty

groupTogetherWith

image

main

maxLength

maxLengthInTable

maxValue

memberType

minLength

minValue

multipleSearch

navigable

numberSelectMode

percentage

precision

prompt

quickAddPropertyName

replacementSearchPath

required

requiredForSearching

searchable

searchCaseSensitive

searchForExactValue

searchPrefixOnly

searchSelectMode

selectMode

showInTable

sortable

styles

textFieldMode

trueRepresentation

url

useThousandsGrouping

visible

week