FormUIGet.Field (Alfresco Web Framework common libraries 5.0.a API)

java.lang.Object
- org.alfresco.web.scripts.forms.FormUIGet.Element
- - org.alfresco.web.scripts.forms.FormUIGet.Field

Enclosing class:: FormUIGet

public class FormUIGet.Field
extends FormUIGet.Element

Represents a field on a form.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`configName`
`protected String`	`content`
`protected FormUIGet.FieldControl`	`control`
`protected String`	`dataKeyName`
`protected String`	`dataType`
`protected String`	`description`
`protected boolean`	`disabled`
`protected String`	`endpointDirection`
`protected String`	`help`
`protected boolean`	`helpEncodeHtml`
`protected String`	`indexTokenisationMode`
`protected String`	`label`
`protected boolean`	`mandatory`
`protected String`	`name`
`protected boolean`	`repeating`
`protected boolean`	`transitory`
`protected String`	`type`
`protected Object`	`value`

Fields inherited from class org.alfresco.web.scripts.forms.FormUIGet.Element
id, kind

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getConfigName()`
`String`	`getContent()`
`FormUIGet.FieldControl`	`getControl()`
`String`	`getDataKeyName()`
`String`	`getDataType()`
`String`	`getDescription()`
`String`	`getEndpointDirection()`
`String`	`getEndpointType()`
`String`	`getHelp()`
`boolean`	`getHelpEncodeHtml()`
`String`	`getIndexTokenisationMode()`
`String`	`getLabel()`
`String`	`getName()`
`String`	`getType()`
`Object`	`getValue()`
`boolean`	`isDisabled()`
`boolean`	`isEndpointMandatory()`
`boolean`	`isEndpointMany()`
`boolean`	`isMandatory()`
`boolean`	`isRepeating()`
`boolean`	`isTransitory()`
`void`	`setConfigName(String configName)`
`void`	`setContent(String content)`
`void`	`setControl(FormUIGet.FieldControl control)`
`void`	`setDataKeyName(String dataKeyName)`
`void`	`setDataType(String dataType)`
`void`	`setDescription(String description)`
`void`	`setDisabled(boolean disabled)`
`void`	`setEndpointDirection(String endpointDirection)`
`void`	`setHelp(String help)`
`void`	`setHelpEncodeHtml(boolean encode)`
`void`	`setId(String id)`
`void`	`setIndexTokenisationMode(String indexTokenisationMode)`
`void`	`setLabel(String label)`
`void`	`setMandatory(boolean mandatory)`
`void`	`setName(String name)`
`void`	`setRepeating(boolean repeating)`
`void`	`setTransitory(boolean transitory)`
`void`	`setType(String type)`
`void`	`setValue(Object value)`
`String`	`toString()`

Methods inherited from class org.alfresco.web.scripts.forms.FormUIGet.Element
getId, getKind

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name
```
protected String name
```

configName
```
protected String configName
```

label
```
protected String label
```

description
```
protected String description
```

help
```
protected String help
```

helpEncodeHtml
```
protected boolean helpEncodeHtml
```

control

protected FormUIGet.FieldControl control

dataKeyName
```
protected String dataKeyName
```

dataType
```
protected String dataType
```

type
```
protected String type
```

content
```
protected String content
```

endpointDirection
```
protected String endpointDirection
```

value
```
protected Object value
```

disabled
```
protected boolean disabled
```

mandatory
```
protected boolean mandatory
```

transitory
```
protected boolean transitory
```

repeating
```
protected boolean repeating
```

indexTokenisationMode
```
protected String indexTokenisationMode
```

Method Detail

setId
```
public void setId(String id)
```

getConfigName
```
public String getConfigName()
```

setConfigName

public void setConfigName(String configName)

getControl

public FormUIGet.FieldControl getControl()

setControl

public void setControl(FormUIGet.FieldControl control)

getDataKeyName
```
public String getDataKeyName()
```

setDataKeyName

public void setDataKeyName(String dataKeyName)

getDataType
```
public String getDataType()
```

setDataType

public void setDataType(String dataType)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

isDisabled
```
public boolean isDisabled()
```

setDisabled

public void setDisabled(boolean disabled)

getLabel
```
public String getLabel()
```

setLabel
```
public void setLabel(String label)
```

isMandatory
```
public boolean isMandatory()
```

setMandatory

public void setMandatory(boolean mandatory)

isTransitory
```
public boolean isTransitory()
```

setTransitory

public void setTransitory(boolean transitory)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isRepeating
```
public boolean isRepeating()
```

setRepeating

public void setRepeating(boolean repeating)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getValue
```
public Object getValue()
```

setValue
```
public void setValue(Object value)
```

getContent
```
public String getContent()
```

setContent

public void setContent(String content)

getHelp
```
public String getHelp()
```

setHelp
```
public void setHelp(String help)
```

getHelpEncodeHtml
```
public boolean getHelpEncodeHtml()
```

setHelpEncodeHtml

public void setHelpEncodeHtml(boolean encode)

getEndpointDirection
```
public String getEndpointDirection()
```

setEndpointDirection

public void setEndpointDirection(String endpointDirection)

getEndpointType
```
public String getEndpointType()
```

isEndpointMandatory
```
public boolean isEndpointMandatory()
```

isEndpointMany
```
public boolean isEndpointMany()
```

getIndexTokenisationMode

public String getIndexTokenisationMode()

setIndexTokenisationMode

public void setIndexTokenisationMode(String indexTokenisationMode)

toString
```
public String toString()
```
Overrides:

toString in class FormUIGet.Element

Class FormUIGet.Field

Field Summary

Fields inherited from class org.alfresco.web.scripts.forms.FormUIGet.Element

Method Summary

Methods inherited from class org.alfresco.web.scripts.forms.FormUIGet.Element

Methods inherited from class java.lang.Object

Field Detail

name

configName

label

description

help

helpEncodeHtml

control

dataKeyName

dataType

type

content

endpointDirection

value

disabled

mandatory

transitory

repeating

indexTokenisationMode

Method Detail

setId

getConfigName

setConfigName

getControl

setControl

getDataKeyName

setDataKeyName

getDataType

setDataType

getDescription

setDescription

isDisabled

setDisabled

getLabel

setLabel

isMandatory

setMandatory

isTransitory

setTransitory

getName

setName

isRepeating

setRepeating

getType

setType

getValue

setValue

getContent

setContent

getHelp

setHelp

getHelpEncodeHtml

setHelpEncodeHtml

getEndpointDirection

setEndpointDirection

getEndpointType

isEndpointMandatory

isEndpointMany

getIndexTokenisationMode

setIndexTokenisationMode

toString