Field (Javlo 2 2.1 API)

java.lang.Object
- org.javlo.fields.Field

All Implemented Interfaces:

Cloneable, Comparable<Field>, IRestItem

Direct Known Subclasses:

FieldBoolean, FieldDate, FieldEmail, FieldEnormousText, FieldFile, FieldFont, FieldInternalLink, FieldLargeText, FieldList, FieldMultiList, FieldNumber, FieldSmallText, FieldWysiwyg, Heading, MetaField, OpenList, OpenMultiList, StaticContent
```
public class Field
extends Object
implements Cloneable, IRestItem, Comparable<Field>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Field.FieldBean

Nested Classes
Modifier and Type	Class and Description
`class`	`Field.FieldBean`

Field Summary

Fields
Modifier and Type	Field and Description
`protected IContentVisualComponent`	`comp`
`protected static String`	`DEFAULT_SEARCH_TYPE`
`protected GlobalContext`	`globalContext`
`protected I18nAccess`	`i18nAccess`
`static String`	`LABEL_CSS`
`protected static int`	`MESSAGE_ERROR`
`protected static int`	`MESSAGE_INFO`
`Properties`	`properties`
`static String`	`SMALL_PART_SIZE`
`static String`	`SMALL_VALUE_SIZE`
`protected StaticConfig`	`staticConfig`
`static String`	`VALUE_SIZE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Field o)`
`protected String`	`createKey(String suffix)`
`void`	`fillRequest(ContentContext ctx)`
`Field.FieldBean`	`getBean(ContentContext ctx)`
`String`	`getCloseRow(ContentContext ctx)`
`Map<String,Object>`	`getContentAsMap(ContentContext ctx)`
`String`	`getCSSClass()`
`Locale`	`getCurrentLocale()`
`List<String>`	`getDefaultLanguages()`
`String`	`getDisplayValue(ContentContext ctx, Locale locale)` return the value "displayable"
`protected String`	`getEditLabelCode()`
`String`	`getEditXHTMLCode(ContentContext ctx)`
`String`	`getEditXHTMLCode(ContentContext ctx, boolean search)`
`String`	`getFieldPrefix(ContentContext ctx)`
`String`	`getFieldSuffix(ContentContext ctx)`
`String`	`getForceModifFieldName()`
`GlobalContext`	`getGlobalContext()`
`I18nAccess`	`getI18nAccess()`
`String`	`getId()`
`String`	`getInitValue()`
`String`	`getInputLabelName()`
`String`	`getInputName()`
`String`	`getLabel()`
`protected String`	`getLabel(ContentContext ctx, Locale locale)`
`Map<String,String>`	`getList(ContentContext ctx, String listName, Locale locale)`
`Integer`	`getMaxSize()`
`String`	`getMessage()`
`int`	`getMessageType()`
`String`	`getMessageTypeCSSClass()`
`String`	`getMetaData(String inKey)`
`String`	`getMetaData(String inKey, String defaultValue)`
`Integer`	`getMinSize()`
`String`	`getName()`
`String`	`getOpenRow(ContentContext ctx)`
`int`	`getOrder()`
`String`	`getPageDescription()`
`String`	`getPlaceholder()`
`String`	`getPropertyValue(String suffix, String defaultValue)`
`Field`	`getReference(ContentContext ctx)`
`DynamicComponent`	`getReferenceComponent(ContentContext ctx)` for field with i18n false, the value come from default language version of the page.
`protected String`	`getReferenceFieldView(ContentContext ctx)` render the field when he is used as reference value in a other language.
`protected String`	`getReferenceValue(ContentContext ctx)`
`Map<String,String>`	`getRemplacementCode()`
`String`	`getSearchEditXHTMLCode(ContentContext ctx)`
`protected String`	`getSearchLabel(ContentContext ctx, Locale locale)`
`String`	`getSearchType()`
`String`	`getSize(ContentContext ctx)` return the size of the component
`String`	`getSpecialClass()`
`StaticConfig`	`getStaticConfig()`
`String`	`getTag()`
`List<Locale>`	`getTranslation()`
`String`	`getType()`
`protected String`	`getUnicName()`
`protected String`	`getUnity(ContentContext ctx)`
`protected String`	`getUnity(ContentContext ctx, Locale locale)`
`protected String`	`getUserLabel()`
`String`	`getUserLabel(ContentContext ctx, Locale locale)`
`String`	`getValue()`
`String`	`getValue(Locale locale)` try to return value with locale and return default value if not.
`Collection<String>`	`getValues()`
`List<String>`	`getValues(ContentContext ctx, Locale locale)` try to return values with locale and return default value if not.
`String`	`getViewListXHTMLCode(ContentContext ctx)`
`String`	`getViewXHTMLCode(ContentContext ctx)`
`int`	`getWidthEdit()`
`boolean`	`initContent(ContentContext ctx)`
`boolean`	`isContentCachable()`
`boolean`	`isDiplayedInList(ContentContext ctx)`
`boolean`	`isFirst()`
`boolean`	`isI18n()` return true if this field is translated.
`boolean`	`isLabelDisplayed()`
`boolean`	`isLabelEditable()`
`boolean`	`isLast()`
`boolean`	`isNeeded()`
`boolean`	`isNeedRefresh()`
`boolean`	`isPertinent(ContentContext ctx)`
`boolean`	`isReadOnly()`
`boolean`	`isRealContent(ContentContext ctx)`
`boolean`	`isSearch()`
`boolean`	`isTitle()`
`boolean`	`isValid()`
`protected boolean`	`isValueTranslatable()`
`boolean`	`isViewDisplayed()`
`boolean`	`isWrapped()`
`static void`	`main(String[] args)`
`protected Field.FieldBean`	`newFieldBean(ContentContext ctx)`
`Field`	`newInstance(IContentVisualComponent inComp)`
`boolean`	`process(ContentContext ctx)` process the field
`protected String`	`referenceEditCode(ContentContext ctx)`
`protected String`	`referenceViewCode(ContentContext ctx)`
`void`	`reload(ContentContext ctx)`
`String`	`renderSelect(ContentContext ctx, String label, String inValue, Map<String,String> inValues, boolean sort, String cssClass)`
`boolean`	`search(ContentContext ctx, String query)`
`void`	`setCurrentLocale(Locale currentLocale)`
`void`	`setFirst(boolean first)`
`void`	`setGlobalContext(GlobalContext globalContext)`
`void`	`setI18nAccess(I18nAccess access)`
`void`	`setId(String id)`
`void`	`setLabel(String label)`
`void`	`setLabelValue(String value)`
`void`	`setLast(boolean last)`
`void`	`setMessage(String message)`
`void`	`setMessageType(int messageType)`
`void`	`setName(String name)`
`void`	`setNeedRefresh(boolean needRefresh)`
`void`	`setPlaceholder(String placeholder)`
`void`	`setProperties(Properties properties)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setStaticConfig(StaticConfig staticConfig)`
`protected void`	`setValue(Collection<String> values)`
`void`	`setValue(String value)`
`void`	`setValues(List<String> values)`
`String`	`toString()`
`boolean`	`transflateFrom(ContentContext ctx, ITranslator translator, String lang)`
`boolean`	`validate()`

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

Field Detail

DEFAULT_SEARCH_TYPE

protected static final String DEFAULT_SEARCH_TYPE

See Also:: Constant Field Values

LABEL_CSS
```
public static String LABEL_CSS
```

VALUE_SIZE
```
public static String VALUE_SIZE
```

SMALL_VALUE_SIZE
```
public static String SMALL_VALUE_SIZE
```

SMALL_PART_SIZE
```
public static String SMALL_PART_SIZE
```

MESSAGE_ERROR
```
protected static final int MESSAGE_ERROR
```
See Also:

Constant Field Values

MESSAGE_INFO
```
protected static final int MESSAGE_INFO
```
See Also:

Constant Field Values

properties
```
public Properties properties
```

staticConfig

protected transient StaticConfig staticConfig

globalContext

protected transient GlobalContext globalContext

i18nAccess

protected transient I18nAccess i18nAccess

comp
```
protected IContentVisualComponent comp
```

Method Detail

newInstance

public Field newInstance(IContentVisualComponent inComp)

getList

public Map<String,String> getList(ContentContext ctx,
                                  String listName,
                                  Locale locale)
                           throws Exception

Throws:: Exception

getInputName
```
public String getInputName()
```

getInputLabelName
```
public String getInputLabelName()
```

validate
```
public boolean validate()
```

isValid
```
public boolean isValid()
```

getEditLabelCode
```
protected String getEditLabelCode()
```

getReferenceComponent

public DynamicComponent getReferenceComponent(ContentContext ctx)
                                       throws Exception

for field with i18n false, the value come from default language version of the page.

Throws:: Exception

isI18n
```
public boolean isI18n()
```
return true if this field is translated.

Returns:

getReferenceFieldView
```
protected String getReferenceFieldView(ContentContext ctx)
                                throws Exception
```
render the field when he is used as reference value in a other language.

Parameters:

ctx -

Returns:

Throws:

Exception

referenceEditCode

protected String referenceEditCode(ContentContext ctx)
                            throws Exception

Throws:: Exception

referenceViewCode

protected String referenceViewCode(ContentContext ctx)
                            throws Exception

Throws:: Exception

getReferenceValue

protected String getReferenceValue(ContentContext ctx)
                            throws Exception

Throws:: Exception

getSpecialClass
```
public String getSpecialClass()
```

getForceModifFieldName

public String getForceModifFieldName()

getEditXHTMLCode

public final String getEditXHTMLCode(ContentContext ctx)
                              throws Exception

Throws:: Exception

getEditXHTMLCode

public String getEditXHTMLCode(ContentContext ctx,
                               boolean search)
                        throws Exception

Throws:: Exception

getSearchEditXHTMLCode

public String getSearchEditXHTMLCode(ContentContext ctx)
                              throws Exception

Throws:: Exception

getFieldPrefix

public String getFieldPrefix(ContentContext ctx)

getViewXHTMLCode

public String getViewXHTMLCode(ContentContext ctx)
                        throws Exception

Throws:: Exception

getViewListXHTMLCode

public String getViewListXHTMLCode(ContentContext ctx)
                            throws Exception

Throws:: Exception

isDiplayedInList

public boolean isDiplayedInList(ContentContext ctx)

getDefaultLanguages

public List<String> getDefaultLanguages()

getDisplayValue

public String getDisplayValue(ContentContext ctx,
                              Locale locale)
                       throws Exception

return the value "displayable"

Parameters:: locale -
Returns:
Throws:: Exception

getPropertyValue

public String getPropertyValue(String suffix,
                               String defaultValue)

getSearchType
```
public String getSearchType()
```

getFieldSuffix

public String getFieldSuffix(ContentContext ctx)

getValue
```
public String getValue(Locale locale)
```
try to return value with locale and return default value if not.

Parameters:

locale -

Returns:

getValues

public List<String> getValues(ContentContext ctx,
                              Locale locale)
                       throws Exception

try to return values with locale and return default value if not.

Parameters:: locale -
Returns:
Throws:: Exception

getValue
```
public String getValue()
```

getInitValue
```
public String getInitValue()
```

getValues
```
public Collection<String> getValues()
```

setValue

protected void setValue(Collection<String> values)

isSearch
```
public boolean isSearch()
```

isNeeded
```
public boolean isNeeded()
```

getMaxSize
```
public Integer getMaxSize()
```

getWidthEdit
```
public int getWidthEdit()
```

getOpenRow

public String getOpenRow(ContentContext ctx)

getCloseRow

public String getCloseRow(ContentContext ctx)

setLast
```
public void setLast(boolean last)
```

isLast
```
public boolean isLast()
```

setFirst
```
public void setFirst(boolean first)
```

isFirst
```
public boolean isFirst()
```

getMinSize
```
public Integer getMinSize()
```

getOrder
```
public int getOrder()
```

setValue
```
public void setValue(String value)
```

setValues

public void setValues(List<String> values)

setLabelValue

public void setLabelValue(String value)

isLabelDisplayed
```
public boolean isLabelDisplayed()
```

getCSSClass
```
public String getCSSClass()
```

getTag
```
public String getTag()
```

isLabelEditable
```
public boolean isLabelEditable()
```

isViewDisplayed
```
public boolean isViewDisplayed()
```

isPertinent

public boolean isPertinent(ContentContext ctx)

getId
```
public String getId()
```

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

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

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

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

getLabel

protected String getLabel(ContentContext ctx,
                          Locale locale)

getUnity

protected String getUnity(ContentContext ctx,
                          Locale locale)

getUnity

protected String getUnity(ContentContext ctx)

getSearchLabel

protected String getSearchLabel(ContentContext ctx,
                                Locale locale)

getUserLabel
```
protected final String getUserLabel()
```

getUserLabel

public String getUserLabel(ContentContext ctx,
                           Locale locale)

setProperties

public void setProperties(Properties properties)

getUnicName
```
protected String getUnicName()
```

process
```
public boolean process(ContentContext ctx)
```
process the field

Parameters:

request -

Returns:

true if the field is modified.

getStaticConfig
```
public StaticConfig getStaticConfig()
```

setStaticConfig

public void setStaticConfig(StaticConfig staticConfig)

getI18nAccess
```
public I18nAccess getI18nAccess()
```

setI18nAccess

public void setI18nAccess(I18nAccess access)

getGlobalContext

public GlobalContext getGlobalContext()

setGlobalContext

public void setGlobalContext(GlobalContext globalContext)

isNeedRefresh
```
public boolean isNeedRefresh()
```

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String message)

getMessageType
```
public int getMessageType()
```

getMessageTypeCSSClass

public String getMessageTypeCSSClass()

setMessageType

public void setMessageType(int messageType)

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

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

setReadOnly

public void setReadOnly(boolean readOnly)

isReadOnly
```
public boolean isReadOnly()
```

isWrapped
```
public boolean isWrapped()
```

fillRequest

public void fillRequest(ContentContext ctx)

newFieldBean

protected Field.FieldBean newFieldBean(ContentContext ctx)

createKey

protected String createKey(String suffix)

getMetaData

public String getMetaData(String inKey,
                          String defaultValue)

getMetaData

public String getMetaData(String inKey)

getTranslation

public final List<Locale> getTranslation()

getCurrentLocale
```
public Locale getCurrentLocale()
```

setCurrentLocale

public void setCurrentLocale(Locale currentLocale)

isContentCachable
```
public boolean isContentCachable()
```

initContent

public boolean initContent(ContentContext ctx)
                    throws Exception

Throws:: Exception

getRemplacementCode

public Map<String,String> getRemplacementCode()

reload

public void reload(ContentContext ctx)

isTitle
```
public boolean isTitle()
```

getPageDescription
```
public String getPageDescription()
```

getReference

public Field getReference(ContentContext ctx)
                   throws Exception

Throws:: Exception

renderSelect

public String renderSelect(ContentContext ctx,
                           String label,
                           String inValue,
                           Map<String,String> inValues,
                           boolean sort,
                           String cssClass)
                    throws Exception

Throws:: Exception

isRealContent

public boolean isRealContent(ContentContext ctx)

getSize
```
public String getSize(ContentContext ctx)
```
return the size of the component

Parameters:

ctx -

Returns:

large, small or normal

getContentAsMap

public Map<String,Object> getContentAsMap(ContentContext ctx)
                                   throws Exception

Specified by:: getContentAsMap in interface IRestItem
Throws:: Exception

search

public boolean search(ContentContext ctx,
                      String query)

compareTo
```
public int compareTo(Field o)
```
Specified by:

compareTo in interface Comparable<Field>

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

toString in class Object

getBean

public Field.FieldBean getBean(ContentContext ctx)

getPlaceholder
```
public String getPlaceholder()
```

setPlaceholder

public void setPlaceholder(String placeholder)

isValueTranslatable

protected boolean isValueTranslatable()

transflateFrom

public boolean transflateFrom(ContentContext ctx,
                              ITranslator translator,
                              String lang)

main

public static void main(String[] args)

Class Field

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEARCH_TYPE

LABEL_CSS

VALUE_SIZE

SMALL_VALUE_SIZE

SMALL_PART_SIZE

MESSAGE_ERROR

MESSAGE_INFO

properties

staticConfig

globalContext

i18nAccess

comp

Method Detail

newInstance

getList

getInputName

getInputLabelName

validate

isValid

getEditLabelCode

getReferenceComponent

isI18n

getReferenceFieldView

referenceEditCode

referenceViewCode

getReferenceValue

getSpecialClass

getForceModifFieldName

getEditXHTMLCode

getEditXHTMLCode

getSearchEditXHTMLCode

getFieldPrefix

getViewXHTMLCode

getViewListXHTMLCode

isDiplayedInList

getDefaultLanguages

getDisplayValue

getPropertyValue

getSearchType

getFieldSuffix

getValue

getValues

getValue

getInitValue

getValues

setValue

isSearch

isNeeded

getMaxSize

getWidthEdit

getOpenRow

getCloseRow

setLast

isLast

setFirst

isFirst

getMinSize

getOrder

setValue

setValues

setLabelValue

isLabelDisplayed

getCSSClass

getTag

isLabelEditable

isViewDisplayed

isPertinent

getId

setId

getType

getName

setName

getLabel

getUnity