LyraFormField (Lyra grid Java library 1.1.10 API)

java.lang.Object
- ru.curs.lyra.kernel.LyraNamedElement
- - ru.curs.lyra.kernel.LyraFormField

public class LyraFormField
extends LyraNamedElement

Lyra form field metadata.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CAPTION` 'Caption' property name.
`static String`	`CSS_CLASS_NAME` 'cssClassName' property name.
`static String`	`CSS_STYLE` 'cssStyle' property name.
`static String`	`DATE_FORMAT` 'dateFormat' property name.
`static String`	`DECIMAL_SEPARATOR` 'decimalSeparator' property name.
`static int`	`DEFAULT_DATE_FORMAT`
`static String`	`DEFAULT_DECIMAL_SEPARATOR`
`static String`	`DEFAULT_GROUPING_SEPARATOR`
`static int`	`DEFAULT_SCALE` Значение по умолчанию для числа знаков после запятой.
`static String`	`EDITABLE` 'Editable' property name.
`static String`	`GROUPING_SEPARATOR` 'groupingSeparator' property name.
`static String`	`REQUIRED` 'Required' property name.
`static String`	`SCALE` 'Scale' property name.
`static String`	`SORTABLE` 'Sortable' property name.
`static String`	`VISIBLE` 'Visible' property name.

Constructor Summary

Constructors
Constructor and Description

LyraFormField(String name)

LyraFormField(String name, FieldAccessor accessor)

Constructors
Constructor and Description
`LyraFormField(String name)`
`LyraFormField(String name, FieldAccessor accessor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldAccessor`	`getAccessor()` Field's getter/setter.
`String`	`getCaption()` Caption of the field.
`String`	`getCssClassName()`
`String`	`getCssStyle()` Get CssStyle.
`int`	`getDateFormat()`
`String`	`getDecimalSeparator()`
`String`	`getGroupingSeparator()`
`String`	`getLookup()` Lookup procedure.
`int`	`getScale()` Number of decimal places after dot.
`LyraFieldType`	`getType()` Field type.
`boolean`	`isEditable()` Is the field editable?
`boolean`	`isRequired()` Is the field required.
`boolean`	`isSortable()` Is the field sortable?
`boolean`	`isVisible()` Is the field visible?
`LyraFormField`	`setCaption(String caption)` Sets new caption.
`LyraFormField`	`setCssClassName(String cssClassName)`
`LyraFormField`	`setCssStyle(String cssStyle)`
`LyraFormField`	`setDateFormat(int dateFormat)`
`LyraFormField`	`setDecimalSeparator(String decimalSeparator)`
`LyraFormField`	`setEditable(boolean editable)` Sets editable property.
`LyraFormField`	`setGroupingSeparator(String groupingSeparator)`
`LyraFormField`	`setLookup(String lookup)` Sets lookup procedure.
`LyraFormField`	`setRequired(boolean required)` Sets required property for a field.
`LyraFormField`	`setScale(int scale)` Sets number of decimal places after dot.
`LyraFormField`	`setSortable(boolean sortable)` Sets sortable property.
`LyraFormField`	`setType(LyraFieldType type)` Sets field type.
`LyraFormField`	`setVisible(boolean visible)` Sets visible property.

Methods inherited from class ru.curs.lyra.kernel.LyraNamedElement
equals, getName, hashCode

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VISIBLE
```
public static final String VISIBLE
```
    'Visible' property name.
    
    See Also:
    
    Constant Field Values
  - EDITABLE
```
public static final String EDITABLE
```
    'Editable' property name.
    
    See Also:
    
    Constant Field Values
  - SORTABLE
```
public static final String SORTABLE
```
    'Sortable' property name.
    
    See Also:
    
    Constant Field Values
  - CAPTION
```
public static final String CAPTION
```
    'Caption' property name.
    
    See Also:
    
    Constant Field Values
  - SCALE
```
public static final String SCALE
```
    'Scale' property name.
    
    See Also:
    
    Constant Field Values
  - REQUIRED
```
public static final String REQUIRED
```
    'Required' property name.
    
    See Also:
    
    Constant Field Values
  - CSS_CLASS_NAME
```
public static final String CSS_CLASS_NAME
```
    'cssClassName' property name.
    
    See Also:
    
    Constant Field Values
  - CSS_STYLE
```
public static final String CSS_STYLE
```
    'cssStyle' property name.
    
    See Also:
    
    Constant Field Values
  - DATE_FORMAT
```
public static final String DATE_FORMAT
```
    'dateFormat' property name.
    
    See Also:
    
    Constant Field Values
  - DECIMAL_SEPARATOR
```
public static final String DECIMAL_SEPARATOR
```
    'decimalSeparator' property name.
    
    See Also:
    
    Constant Field Values
  - GROUPING_SEPARATOR
```
public static final String GROUPING_SEPARATOR
```
    'groupingSeparator' property name.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCALE
```
public static final int DEFAULT_SCALE
```
    Значение по умолчанию для числа знаков после запятой.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATE_FORMAT
```
public static final int DEFAULT_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DECIMAL_SEPARATOR
```
public static final String DEFAULT_DECIMAL_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_GROUPING_SEPARATOR
```
public static final String DEFAULT_GROUPING_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LyraFormField
```
public LyraFormField(String name)
```
  - LyraFormField
```
public LyraFormField(String name,
                     FieldAccessor accessor)
```
- Method Detail
  - getCssClassName
```
public String getCssClassName()
```
  - setCssClassName
```
public LyraFormField setCssClassName(String cssClassName)
```
  - getCssStyle
```
public String getCssStyle()
```
    Get CssStyle.
  - setCssStyle
```
public LyraFormField setCssStyle(String cssStyle)
```
  - getType
```
public LyraFieldType getType()
```
    Field type.
  - setType
```
public LyraFormField setType(LyraFieldType type)
```
    Sets field type.
    
    Parameters:
    
    type - the type to set
  - isEditable
```
public boolean isEditable()
```
    Is the field editable?
  - setEditable
```
public LyraFormField setEditable(boolean editable)
```
    Sets editable property.
    
    Parameters:
    
    editable - editable property.
  - isSortable
```
public boolean isSortable()
```
    Is the field sortable?
  - setSortable
```
public LyraFormField setSortable(boolean sortable)
```
    Sets sortable property.
    
    Parameters:
    
    sortable - sortable property.
  - isVisible
```
public boolean isVisible()
```
    Is the field visible?
  - setVisible
```
public LyraFormField setVisible(boolean visible)
```
    Sets visible property.
    
    Parameters:
    
    visible - the visible to set
  - getCaption
```
public String getCaption()
```
    Caption of the field.
  - setCaption
```
public LyraFormField setCaption(String caption)
```
    Sets new caption.
    
    Parameters:
    
    caption - the caption to set
  - getLookup
```
public String getLookup()
```
    Lookup procedure.
  - setLookup
```
public LyraFormField setLookup(String lookup)
```
    Sets lookup procedure.
    
    Parameters:
    
    lookup - the lookup procedure to set
  - getAccessor
```
public FieldAccessor getAccessor()
```
    Field's getter/setter.
  - getScale
```
public int getScale()
```
    Number of decimal places after dot.
  - setScale
```
public LyraFormField setScale(int scale)
```
    Sets number of decimal places after dot.
    
    Parameters:
    
    scale - new value.
  - isRequired
```
public boolean isRequired()
```
    Is the field required.
  - setRequired
```
public LyraFormField setRequired(boolean required)
```
    Sets required property for a field.
    
    Parameters:
    
    required - new value
  - getDateFormat
```
public int getDateFormat()
```
  - setDateFormat
```
public LyraFormField setDateFormat(int dateFormat)
```
  - getDecimalSeparator
```
public String getDecimalSeparator()
```
  - setDecimalSeparator
```
public LyraFormField setDecimalSeparator(String decimalSeparator)
```
  - getGroupingSeparator
```
public String getGroupingSeparator()
```
  - setGroupingSeparator
```
public LyraFormField setGroupingSeparator(String groupingSeparator)
```

Class LyraFormField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ru.curs.lyra.kernel.LyraNamedElement

Methods inherited from class java.lang.Object

Field Detail

VISIBLE

EDITABLE

SORTABLE

CAPTION

SCALE

REQUIRED

CSS_CLASS_NAME

CSS_STYLE

DATE_FORMAT

DECIMAL_SEPARATOR

GROUPING_SEPARATOR

DEFAULT_SCALE

DEFAULT_DATE_FORMAT

DEFAULT_DECIMAL_SEPARATOR

DEFAULT_GROUPING_SEPARATOR

Constructor Detail

LyraFormField

LyraFormField

Method Detail

getCssClassName

setCssClassName

getCssStyle

setCssStyle

getType

setType

isEditable

setEditable

isSortable

setSortable

isVisible

setVisible

getCaption

setCaption

getLookup

setLookup

getAccessor

getScale

setScale

isRequired

setRequired

getDateFormat

setDateFormat

getDecimalSeparator

setDecimalSeparator

getGroupingSeparator

setGroupingSeparator