com.jalios.jcms

Class TypeFieldEntry

Parameters:
data - the data from which to retrive the given field
lang - the lang in which to retrieve the field if multilang
Returns:
the value of this field as a String, null if the field value cannot be converted to the type String.
Throws:
java.lang.NoSuchFieldException - if the field was not found in the given Data.
Parameters:
data - the data from which to retrive the given field
lang - the lang in which to retrieve the field, if field is multi-lang
Returns:
the value of this field as a String[], null if the field value cannot be converted to the type String[].
Throws:
java.lang.NoSuchFieldException - if the field was not found in the given Data.

  • getCollectionTypeMapping

    public java.lang.String getCollectionTypeMapping()

  • isTypeInt

    public boolean isTypeInt()
    Type: int?
    Returns:
    true if this field is an int.
    See Also:
    getType()

  • isTypeIntArray

    public boolean isTypeIntArray()
    Type: int[]?
    Returns:
    true if this field is an int[].
    See Also:
    getType()

  • isTypeLong

    public boolean isTypeLong()
    Type: long?
    Returns:
    true if this field is an long.
    See Also:
    getType()

  • isTypeLongArray

    public boolean isTypeLongArray()
    Type: long[]?
    Returns:
    true if this field is an long[].
    See Also:
    getType()

  • isTypeDouble

    public boolean isTypeDouble()
    Type: double?
    Returns:
    true if this field is an double.
    See Also:
    getType()

  • isTypeDoubleArray

    public boolean isTypeDoubleArray()
    Type: double[]?
    Returns:
    true if this field is an double[].
    See Also:
    getType()

  • isTypeBoolean

    public boolean isTypeBoolean()
    Type: boolean?
    Returns:
    true if this field is an boolean.
    See Also:
    getType()

  • isTypeBooleanArray

    public boolean isTypeBooleanArray()
    Type: boolean[]?
    Returns:
    true if this field is an boolean[].
    See Also:
    getType()

  • isTypeString

    public boolean isTypeString()
    Type: String?
    Returns:
    true if this field is an String.
    See Also:
    getType()

  • isTypeStringArray

    public boolean isTypeStringArray()
    Type: String[]?
    Returns:
    true if this field is an String[].
    See Also:
    getType()

  • isTypeDate

    public boolean isTypeDate()
    Type: Date?
    Returns:
    true if this field is an Date.
    See Also:
    getType()

  • isTypeDateArray

    public boolean isTypeDateArray()
    Type: Date[]?
    Returns:
    true if this field is an Date[].
    See Also:
    getType()

  • isTypeScalar

    public boolean isTypeScalar()
    Returns:
    true if the field's type is a scalar of any possible type.
    See Also:
    getType()

  • isTypeMV

    public boolean isTypeMV()
    Returns:
    true if the field's type is a multivalued (array, List or Set) of any possible type.
    See Also:
    getType()

  • isTypeArray

    public boolean isTypeArray()
    Returns:
    true if the field's type is an array of any possible type.
    See Also:
    getType()

  • isTypeList

    public boolean isTypeList()
    Returns:
    true if the field's type is a List of any possible type.
    See Also:
    getType()

  • isTypeSet

    public boolean isTypeSet()
    Returns:
    true if the field's type is a Set of any possible type.
    See Also:
    getType()

  • isTypeCollection

    public boolean isTypeCollection()
    Returns:
    true if the field's type is a Collection (List or Set) of any possible type.
    See Also:
    getType()

  • isTypeCategory

    public boolean isTypeCategory()
    Returns:
    true if the field's type is "java.util.TreeSet" and editor is "category". (field is a TreeSet of Category).
    See Also:
    getEditor(), getType()

  • isTypePublication

    public boolean isTypePublication()
    Type: Publication?
    Returns:
    true if this field is a Publication.
    See Also:
    getType()

  • isTypePublicationArray

    public boolean isTypePublicationArray()
    Type: Publication[]?
    Returns:
    true if this field is a Publication[].
    See Also:
    getType()

  • isTypePublicationMV

    public boolean isTypePublicationMV()
    Type: Publication MV
    Returns:
    true if this field is a Publication[], a List or Set.
    See Also:
    getType()

  • isTypeDocument

    public boolean isTypeDocument()
    Type: FileDocument? or DBFileDocument?
    Returns:
    true if this field is a Document.
    See Also:
    getType()

  • isTypeDocumentMV

    public boolean isTypeDocumentMV()
    Type: FileDocument MV? or DBFileDocument MV?
    Returns:
    true if this field is a FileDocument[], a List or Set.
    See Also:
    getType()

  • isRequired

    public boolean isRequired()
    Required field?
    Returns:
    true if this field is required, false otherwise

  • isInline

    public boolean isInline()
    Inline editing ?
    Returns:
    true if this field is to be edited directly in the form, false otherwise (through a popup or such)

  • isHidden

    public boolean isHidden()
    Hidden field?
    Returns:
    true if this field is hidden, false otherwise

  • isAbstract

    public boolean isAbstract()
    Abstract/Summary field?
    Returns:
    true if this field is the summary for the type, false otherwise

  • getAbstractLength

    public int getAbstractLength()
    Abstract/Summary length
    Returns:
    the length of the abstract

  • isDataImage

    public boolean isDataImage()
    Image field?
    Returns:
    true if this field is the image for the type, false otherwise

  • isSearchable

    public boolean isSearchable()
    Searchable field
    Returns:
    true if this field is searchable, false otherwise

  • isSimpleString

    public boolean isSimpleString()
    Returns:
    true if this field's type is a String or a String[] AND not an enumerate neither a wysywig.
    See Also:
    getType(), isEnumerate(), isWysiwyg()

  • isSuper

    public boolean isSuper()
    Returns:
    true if this field is not really a field, but instead, the place (for the edit form) where the inherited field are located.
    See Also:
    getType()

  • getEditor

    public java.lang.String getEditor()
    Return the internal editor type of this field.
    Can be one of these values (list not exhaustive):
  • "category"
  • "color"
  • "date"
  • "email"
  • "enumerate"
  • "file"
  • "image"
  • "media"
  • "password"
  • "query"
  • "textarea"
  • "textfield"
  • "url"
  • "wysiwyg"
  • "radio"
  • "check"
  • "list"
  • "combo"
  • "int", "int[]"
  • "double", "double[]"
  • "boolean", "boolean[]"
  • "member", "member[]"
  • "group", "group[]"
  • "link", "link[]"
  • "duration", "duration[]"
  • "date", "date[]"
  • "sqlquery", "sqlquery[]"
  • "dbrecord", "dbrecord[]"
    • Returns:
    the field's editor as a String

  • isLink

    public boolean isLink()
    Is field's editor a link (as opposed to a chooser for example). (UI related).
    Returns:
    true if this field is a link
    See Also:
    getEditor()

  • isAnyLink

    public boolean isAnyLink()
    Is field's editor any type of link (i.e. link or member or group).
    Returns:
    true if this field is any type of link.
    Since:
    jcms-6.1.0

  • getChooser

    public java.lang.String getChooser()
    Return the internal "chooser" of this field.
    Can be one of these values (list not exhaustive):
  • "checkbox"
  • "combo"
  • "listbox"
  • "multilistbox"
  • "popup"
  • "tree"
    • Returns:
    the chooser value of this field, if any, otherwise may return empty string or null.

  • isFieldML

    public boolean isFieldML()
    Returns:
    true if this field a multi-language field.

  • getDefaultValue

    public java.lang.String getDefaultValue()
    Default value of field that can be expressed/converted into a string.
    Returns:
    a String with the default value of this field.

  • getDefaultTextMap

    public java.util.HashMap<java.lang.String,java.lang.String> getDefaultTextMap()
    Returns a copy of the language map of default value for this textual field.
    Returns:
    the language map of default value for this field. Returns an empty map if there is no default value.
    Since:
    jcms-5.7.3

  • getDefaultTextString

    public java.lang.String getDefaultTextString()
    Returns the default value (in the main language) of this textual field.
    Returns:
    the default value (in the main language) of this textual field. Returns null if there is no default value.
    Since:
    jcms-5.7.3

  • isUrl

    public boolean isUrl()
    URL.
    Returns:
    true if field is a url field, false otherwise.

  • isFieldWiki

    public boolean isFieldWiki()
    TextArea.
    Returns:
    true if field is a wiki field, false otherwise.

  • isFieldWikiwyg

    public boolean isFieldWikiwyg()
    TextArea.
    Returns:
    true if field is a wikiwyg field, false otherwise.

  • isWysiwyg

    public boolean isWysiwyg()
    Wysiwyg.
    Returns:
    true if this field is a wysiwyg, false otherwise.

  • getCols

    public int getCols()
    TextInput/TextArea columns number.
    (UI related)
    Returns:
    the number of columns to use in the form textinput or textarea.

  • getMaxlength

    public int getMaxlength()
    TextInput maximum length.
    Returns:
    the maximum length of a text input.

  • getRows

    public int getRows()
    TextArea/WYSIWYG rows number.
    (UI related)
    Returns:
    the number of rows to use in the form textarea or in a wysiwyg.

  • getUnit

    public java.lang.String getUnit()
    TextInput unit
    e.g. "$"
    Returns:
    the unit.

  • getUnitBefore

    public java.lang.String getUnitBefore()
    TextInput unit, displayed before input.
    e.g. "$"
    Returns:
    the unit displayed before a text input.

  • getUnitAfter

    public java.lang.String getUnitAfter()
    TextInput unit, displayed after input.
    e.g. "km"
    Returns:
    the unit displayed after a text input.

  • getDecimals

    public int getDecimals()
    Double decimals count
    Returns:
    the decimals count for double fields.

  • getWysiwygParams

    public java.lang.String getWysiwygParams()
    WYSIWYG toolbar options.
    Computed from xml field attribute toolbar[0-4]. e.g. : &toolbar0=open&toolbar1=open&toolbar2=open&toolbar3=open&toolbar4=hidden (UI related)
    Returns:
    a string with wysiwyg toolbar options.

  • isImageMap

    public boolean isImageMap()
    Returns true if this is an image field with imageMap option enabled.
    Returns:
    true if this is an image field with imageMap option enabled.
    Since:
    jcms-5.5.0

  • isOpenWindow

    public boolean isOpenWindow()
    Returns true if this is an URL field which must be open in a new window.
    Returns:
    true if this is an URL field which must be open in a new window.
    Since:
    jcms-6.1.0

  • isResize

    public boolean isResize()
    Returns true if this is an image field which must be resized.
    Returns:
    true if this is an image field which must be resized.
    Since:
    jcms-6.1.0

  • getResizeWidth

    public int getResizeWidth()
    Returns the resize width
    Returns:
    the resize width
    Since:
    jcms-6.1.0

  • getResizeHeight

    public int getResizeHeight()
    Returns the resize height
    Returns:
    the resize height
    Since:
    jcms-6.1.0

  • escapeHtml

    public boolean escapeHtml()
    Returns true if the HTML contained in this field must be escaped.
    Returns:
    true if the HTML contained in this field must be escaped.
    Since:
    jcms-6.1.0

  • isSlaveImageMap

    public boolean isSlaveImageMap()
    Returns true if this field is the text area field generated aside the real image field.
    Warning: this field was not really saved in the type's xml, but is instead only created at JSP generation time.
    Returns:
    true if this field is the text area associated with the image map field.

  • isMasterImageMap

    public boolean isMasterImageMap()
    Returns true if this field is the image field of an image map field.
    Returns:
    true if this field is the image field of an image map field.

  • getMinValue

    public java.lang.Integer getMinValue()
    Returns the min value if it is set
    Returns:
    the min value if it is set

  • getMaxValue

    public java.lang.Integer getMaxValue()
    Returns the max value if it is set
    Returns:
    the max value if it is set

  • getDataSource

    public java.lang.String getDataSource()
    SQLQuery/DBRecord/SQLResult: data source of this SQL related field.
    Returns:
    the data source of the SQL field

  • getMaxRows

    public int getMaxRows()
    SQLQuery/DBRecord/SQLResult: maximum row to be retrieved (0 means no limit)
    Returns:
    the maximum number of rows to be retrieved.

  • getDbrTable

    public java.lang.String getDbrTable()
    DBRecord: table of this DB record field.
    Returns:
    the name of the SQL table used for this DB record field.

  • getDbrKeyCol

    public java.lang.String getDbrKeyCol()
    DBRecord: primary key column of this DB record field.
    Returns:
    the name of primary key SQL column used for this DB record field.

  • getDbrColumns

    public java.lang.String getDbrColumns()
    DBRecord: columns to be listed for this DB record field (coma separated)
    Returns:
    a String with coma separated SQL columns name SQL listed for this DB record field.

  • getDbrLabelCol

    public java.lang.String getDbrLabelCol()
    DBRecord: column used as label for this DB record field
    Returns:
    a String with the SQL column name used a label for this DB record field

  • getDbrOrderBy

    public java.lang.String getDbrOrderBy()
    DBRecord: ORDER BY SQL criteria DB record field
    Returns:
    a String with the ORDER BY SQL criteria for this DB record field

  • isEnumerate

    public boolean isEnumerate()
    Enumerate.
    Returns:
    true if this field a an enumerate.

  • getSize

    public int getSize()
    Enumerate: html Select size.
    (UI related)
    Returns:
    the size of a select in a html form.

  • getEnumerateLabels

    public java.lang.String[] getEnumerateLabels()
    Enumerate: Labels of this enumerate field, e.g { "Red", "Green", "Blue"} for the default language of the type/site.
    Returns:
    a String[] containing all labels for this field, or null if this field is not an enumerate

  • getEnumerateLabelsMap

    public java.util.HashMap<java.lang.String,java.lang.String[]> getEnumerateLabelsMap()
    Enumerate: Map of 'language to labels' for this enumerate field, e.g {{"en" -> { "Red", "Green", "Blue"}, "fr" -> ... }} for the default language of the type/site.
    Returns:
    a String[] containing all labels for this field, or null if this field is not an enumerate
    Since:
    jcms-8.0.0

  • getEnumerateValues

    public java.lang.String[] getEnumerateValues()
    Enumerate: Possible values of this enumerate field, e.g { "00FF00", "00FF00", "0000FF"}.
    Returns:
    a String[] containing all values for this field, or null if this field is not an enumerate.

  • isEnumerateML

    public boolean isEnumerateML()
    Deprecated. this value might not reflect the proper translation status of the label list, you should now consider that enumerate label are always I18Ned
    Enumerate: multilanguage.
    Returns:
    true if this field has multilanguage labels (field contains labelList_en... etc).

  • isDateOnly

    public boolean isDateOnly()
    DateChooser: use date only, or date and time?
    Returns:
    true if this field was specified to use date only (no time).

  • getDateFormat

    public java.lang.String getDateFormat()
    DateChooser: date format
    Returns:
    the date format.

  • getRoot

    public java.lang.String getRoot()
    Categories: Root Category ID of this category field
    Returns:
    a String with the ID of the root Category of this field

  • isDisplayRoot

    public boolean isDisplayRoot()
    Categories: Display Root
    Returns:
    true if this Category field should display its root

  • isExclusive

    public boolean isExclusive()
    Categories: Exclusive.
    (UI related)
    Returns:
    true if only one category can be selected in html form, false otherwise.

  • getGids

    public java.lang.String[] getGids()
    Member chooser: Group IDs
    Returns:
    a String[] containing the jcms id of the Group from which we choose Member.

  • getOffLabelMap

    public java.util.Map getOffLabelMap()
    Boolean: false/OFF Label of a boolean field. e.g. "No", "Disabled"
    Returns:
    Map {language, label} with the label to use for the false/off value of this boolean.

  • getOffLabel

    public java.lang.String getOffLabel(java.lang.String lang)
    Returns the localized offLabel for to this field.
    Parameters:
    lang - the language
    Returns:
    the localized offLabel for to this field.
    Since:
    jcms-5.7.0

  • getOnLabelMap

    public java.util.Map getOnLabelMap()
    Boolean: true/ON Label of a boolean field. e.g. "Yes", "Enabled"
    Returns:
    Map {language, label} with the label to use for the true/on value of this boolean.

  • getOnLabel

    public java.lang.String getOnLabel(java.lang.String lang)
    Returns the localized onLabel for to this field.
    Parameters:
    lang - the language
    Returns:
    the localized onLabel for to this field.
    Since:
    jcms-5.7.0

  • getTab

    public java.lang.String getTab()
    Tab: tab name in which this field will be displayed.
    Returns:
    a String with the name of the tab.

  • getTabGroup

    public java.lang.String getTabGroup()
    TabGroup: group name for multivalued fields, all field having the same value will be display together. (has nothing to do with Tab). e.g. Interview type has two multivalued fields, "questions" and "answers" with the same tabgroup, when switching to second value of "questions", we display the second value of "answers". (UI related)
    Returns:
    name of group name

  • isWidget

    public boolean isWidget()
    Is this field manage through a widget
    Returns:
    true if this field manage through a widget.

  • getWidgetEditor

    public int getWidgetEditor()
    Type of widget editor. see AbstractWidget#UI_EDITOR_*.
    e.g : AbstractWidget.UI_EDITOR_EMAIL
    Returns:
    an int indicating what type of widget editor is used.

  • getWidgetDescription

    public int getWidgetDescription()
    Type of description to be used by widget:
  • AbstractWidget.UI_DESCRIPTION_NONE
  • AbstractWidget.UI_DESCRIPTION_TEXT
  • AbstractWidget.UI_DESCRIPTION_TOOLTIP
    • Returns:
    an int indicating what type of description will be display.

  • isMbrChsr

    public boolean isMbrChsr()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_MEMBERCHOOSER

  • isMbrEnum

    public boolean isMbrEnum()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_ENUMERATE_MEMBER

  • isGrpChsr

    public boolean isGrpChsr()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_GROUPCHOOSER

  • isGrpEnum

    public boolean isGrpEnum()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_ENUMERATE_GROUP

  • isDateChsr

    public boolean isDateChsr()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_DATECHOOSER

  • isCatEditor

    public boolean isCatEditor()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_ENUMERATE_CATEGORIES

  • isSQLQuery

    public boolean isSQLQuery()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_SQLQUERY

  • isDBRecordChsr

    public boolean isDBRecordChsr()
    Widget Type.
    Returns:
    true if the widget editor for this field is AbstractWidget.UI_EDITOR_DBRECORDCHOOSER

  • isCatTreeEditor

    public boolean isCatTreeEditor()
    Widget Type.
    Returns:
    true if this field is not managed through widget editor but using a category tree editor

  • isKeyword

    public boolean isKeyword()
    Return true if the field display keywords
    Returns:
    boolean true if

Copyright © 2001-2010 Jalios SA. All Rights Reserved.