com.jalios.jcms.widget

Class AbstractWidget

java.lang.Object

com.jalios.jcms.widget.AbstractWidget

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

DBRecordChooserWidget, DurationWidget, EnumerateWidget, QueryWidget, TextAreaWidget, TextFieldWidget

public abstract class AbstractWidget
extends java.lang.Object
implements JcmsConstants

Field Summary

Fields

Modifier and Type	Field and Description
protected Channel	channel
protected JcmsJspContext	context
protected java.lang.String	css
protected java.lang.String	customAttributes
protected java.lang.String	defaultValue
protected java.lang.String	description
protected int	descriptionUI
protected boolean	disabled
protected int	editorUI
protected java.lang.String	firstInputID
protected boolean	forceUpDown
protected java.lang.String	formName
protected boolean	hidden
protected java.lang.String	hiddenActions
protected boolean	inline
protected boolean	isTabbed
protected int	itemCount How many items this "list" widget is composed of
protected boolean	keyword
protected java.lang.String	label
protected java.util.List<java.lang.String>	languageList
protected static org.apache.log4j.Logger	logger
protected boolean	multilingual
protected java.lang.String	placeholder
protected boolean	printLabel
protected boolean	printSeparator
protected boolean	printWidget
protected boolean	required
static java.lang.String	REVISION
protected boolean	showAddButton
protected boolean	showAddIcons
protected boolean	showCalendarIcons
protected boolean	showCategoryButton
protected boolean	showColorChooser
protected boolean	showCreateIcons
protected boolean	showDBRecChooser
protected boolean	showDocChooser
protected boolean	showDownIcons
protected boolean	showEditIcons
protected boolean	showGrpChooser
protected boolean	showImageChooser
protected boolean	showLeftIcons
protected boolean	showLinkID
protected boolean	showMediaChooser
protected boolean	showMrbChooser
protected boolean	showQueryChooser
protected boolean	showRemoveIcons
protected boolean	showRightIcons
protected boolean	showSelectIcons
protected boolean	showTrashIcons
protected boolean	showUpIcons
protected boolean	showWebdavChooser
protected java.lang.String	tabGroup
protected int	tabIndex
static int	UI_DESCRIPTION_NONE
static int	UI_DESCRIPTION_TEXT
static int	UI_DESCRIPTION_TOOLTIP
static int	UI_EDITOR_ACLCHOOSER
static int	UI_EDITOR_CATEGORIESCHOOSER
static int	UI_EDITOR_CATEGORYCHOOSER
static int	UI_EDITOR_CATEGORYTREE
static int	UI_EDITOR_COLORCHOOSER
static int	UI_EDITOR_DATECHOOSER
static int	UI_EDITOR_DBRECORDCHOOSER
static int	UI_EDITOR_DURATIONCHOOSER
static int	UI_EDITOR_EMAIL
static int	UI_EDITOR_ENUMERATE_BOOLEAN
static int	UI_EDITOR_ENUMERATE_CATEGORIES
static int	UI_EDITOR_ENUMERATE_CHECK
static int	UI_EDITOR_ENUMERATE_COMBO
static int	UI_EDITOR_ENUMERATE_GROUP
static int	UI_EDITOR_ENUMERATE_LIST
static int	UI_EDITOR_ENUMERATE_MEMBER
static int	UI_EDITOR_ENUMERATE_RADIO
static int	UI_EDITOR_FILEPATH
static int	UI_EDITOR_GROUPCHOOSER
static int	UI_EDITOR_GROUPSCHOOSER
static int	UI_EDITOR_IMAGEMAPAREA
static int	UI_EDITOR_IMAGEPATH
static int	UI_EDITOR_MEDIAPATH
static int	UI_EDITOR_MEMBERCHOOSER
static int	UI_EDITOR_MEMBERSCHOOSER
static int	UI_EDITOR_PASSWORD
static int	UI_EDITOR_PUBLICATIONCHOOSER
static int	UI_EDITOR_PUBLICATIONSCHOOSER
static int	UI_EDITOR_QUERYCHOOSER
static int	UI_EDITOR_RICHTEXT
static int	UI_EDITOR_SIMPLEIMAGEPATH
static int	UI_EDITOR_SIMPLEMEDIAPATH
static int	UI_EDITOR_SQLQUERY
static int	UI_EDITOR_TEXTAREA
static int	UI_EDITOR_TEXTFIELD
static int	UI_EDITOR_TEXTFIELD_DOUBLE
static int	UI_EDITOR_TEXTFIELD_INTEGER
static int	UI_EDITOR_URL
static int	UI_EDITOR_WARNAREA
static int	UI_EDITOR_WIKIAREA
static int	UI_EDITOR_WORKSPACECHOOSER
protected java.lang.String	userLang
protected java.util.Map	valueMap
protected java.lang.String[]	values
protected int	widgetAddCount
protected java.lang.String	widgetId
protected java.lang.String	widgetName
protected java.lang.String	wrapper

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
AbstractWidget()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String[]	convertObject(java.lang.Object obj) Try to convert an Object of Object[] to String[]
protected int	getAddComponentCount() Return the number of additional form elements
protected java.util.Collection	getAllValues() Return All the values from values[] or Map in a Collection always return a collection, never null
protected int	getComponentCount() Returns the number of form elements (input, textarea, button,...).
JcmsJspContext	getContext()
java.lang.String	getCss()
java.lang.String	getCustomAttributes()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
static java.lang.String	getDescriptionName(int editor)
int	getDescriptionUI()
static int	getEditor(java.lang.String name)
static java.lang.String	getEditorName(int editor)
int	getEditorUI()
java.lang.String	getFormName()
java.lang.String	getHiddenActions()
protected java.lang.String	getInputId(boolean first)
protected java.lang.String	getInputTitle(int count, java.lang.String lang) Returns what has to be added as attribute in an input tag.
boolean	getKeyword()
java.lang.String	getLabel()
protected java.lang.String	getListWidgetEditor(int startingIndex)
protected java.lang.String	getListWidgetEditor(int startingIndex, java.lang.String flag) Print a list of widget
protected java.lang.String	getListWidgetEditorByLI(int startingIndex, java.lang.String flag) Print a list of widget using an LI presentation
java.lang.String	getMessage(java.lang.String msg) Return a convenient i18n message.
java.lang.String	getPlaceholder()
boolean	getShowAddButton()
java.lang.String	getTabGroup()
int	getTabIndex()
int	getTotalComponentCount() Return the total of form element generated
java.lang.String	getValue()
java.lang.String	getValue(int count, java.lang.String def) Return the value regarding the values[] or Map
java.lang.String[]	getValues()
java.lang.String	getWidget() Print the Widget
int	getWidgetAddCount()
protected java.lang.String	getWidgetDescriptionText(boolean force)
protected java.lang.String	getWidgetDescriptionTooltip() Print the Description of the Widget
protected java.lang.String	getWidgetEditor(int count) Print the Editor of the Widget
protected java.lang.String	getWidgetEditor(int count, java.lang.String lang)
protected abstract java.lang.String	getWidgetEditor(int count, java.lang.String lang, java.lang.String inputId)
protected java.lang.String	getWidgetHidden() Print all the values to hidden
protected java.lang.String	getWidgetLang()
java.lang.String	getWidgetName()
protected void	getWidgetTab(java.lang.StringBuffer sb)
protected void	getWidgetTabAdd(java.lang.StringBuffer sb)
protected java.lang.String	getWidgetTitle() Print the Title of the Widget
java.lang.String	getWrapper()
void	initWidget() Set local Attribute from attribute Map
boolean	isDisabled()
boolean	isEditorCtxMenu(int editor) Returns true if editor needs a ctxmenu
boolean	isHidden()
boolean	isInline()
boolean	isKeywordDisplay()
boolean	isMultilingual()
boolean	isMultivalued() Returns true if the widget is multivalued
boolean	isPrintSeparator()
boolean	isPrintWidget()
boolean	isRequired()
boolean	isShowAddButton()
boolean	isTabbedEditor(int editor)
protected void	printTabbedFieldAndItemIcons(java.lang.StringBuffer buffer, int i, int startingIndex, int wdgIndex, java.lang.String lang)
void	setContext(JcmsJspContext context)
void	setCss(java.lang.String css)
void	setCustomAttributes(java.lang.String customAttributes)
void	setDefaultValue(java.lang.String defaultValue)
void	setDescription(java.lang.String description)
void	setDescriptionUI(int descriptionUI)
void	setDisabled(boolean disabled)
void	setEditorUI(int editorUI)
void	setFormName(java.lang.String formName)
void	setHidden(boolean hidden)
void	setHiddenActions(java.lang.String hiddenActions) Set the string which define which actions are hidden from this widget, where each letter is associated with one action: A - Add B - DBRecord chooser C - Create D - Down / Right E - Edit F - Color chooser G - Group Chooser H - Member Chooser I - Image Chooser (upload) J - K - Calendar L - Id (data link) M - Media chooser N - O - Q - Query chooser R - Remove S - Select (Pub Chooser) T - Trash U - Up / Left V - W - Webdav Chooser X - Doc Chooser Y - CategoryChooser Z - WorkspaceChooser
void	setInline(boolean inline)
void	setIsTabbed(boolean isTabbed)
void	setKeyword(boolean keyword)
void	setLabel(java.lang.String label)
void	setLanguageList(java.util.List<java.lang.String> languageList)
void	setMultilingual(boolean multilingual)
void	setPlaceholder(java.lang.String placeholder)
void	setPrintLabel(boolean printLabel)
void	setPrintSeparator(boolean printSeparator)
void	setPrintWidget(boolean printWidget)
void	setRequired(boolean required)
void	setShowAddButton(boolean showAddButton)
void	setTabGroup(java.lang.String tabGroup)
void	setTabIndex(int tabIndex)
void	setValue(java.lang.String value)
void	setValues(java.lang.Object values)
void	setWidgetAddCount(int widgetAddCount)
void	setWidgetInitCount(int widgetInitCount)
void	setWidgetName(java.lang.String widgetName)
void	setWrapper(java.lang.String wrapper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

UI_DESCRIPTION_NONE

public static final int UI_DESCRIPTION_NONE

See Also:

Constant Field Values

UI_DESCRIPTION_TOOLTIP

public static final int UI_DESCRIPTION_TOOLTIP

See Also:

Constant Field Values

UI_DESCRIPTION_TEXT

public static final int UI_DESCRIPTION_TEXT

See Also:

Constant Field Values

UI_EDITOR_TEXTFIELD

public static final int UI_EDITOR_TEXTFIELD

See Also:

Constant Field Values

UI_EDITOR_TEXTFIELD_INTEGER

public static final int UI_EDITOR_TEXTFIELD_INTEGER

See Also:

Constant Field Values

UI_EDITOR_TEXTFIELD_DOUBLE

public static final int UI_EDITOR_TEXTFIELD_DOUBLE

See Also:

Constant Field Values

UI_EDITOR_FILEPATH

public static final int UI_EDITOR_FILEPATH

See Also:

Constant Field Values

UI_EDITOR_IMAGEPATH

public static final int UI_EDITOR_IMAGEPATH

See Also:

Constant Field Values

UI_EDITOR_SIMPLEIMAGEPATH

public static final int UI_EDITOR_SIMPLEIMAGEPATH

See Also:

Constant Field Values

UI_EDITOR_MEDIAPATH

public static final int UI_EDITOR_MEDIAPATH

See Also:

Constant Field Values

UI_EDITOR_SIMPLEMEDIAPATH

public static final int UI_EDITOR_SIMPLEMEDIAPATH

See Also:

Constant Field Values

UI_EDITOR_URL

public static final int UI_EDITOR_URL

See Also:

Constant Field Values

UI_EDITOR_EMAIL

public static final int UI_EDITOR_EMAIL

See Also:

Constant Field Values

UI_EDITOR_PASSWORD

public static final int UI_EDITOR_PASSWORD

See Also:

Constant Field Values

UI_EDITOR_COLORCHOOSER

public static final int UI_EDITOR_COLORCHOOSER

See Also:

Constant Field Values

UI_EDITOR_TEXTAREA

public static final int UI_EDITOR_TEXTAREA

See Also:

Constant Field Values

UI_EDITOR_WIKIAREA

public static final int UI_EDITOR_WIKIAREA

See Also:

Constant Field Values

UI_EDITOR_RICHTEXT

public static final int UI_EDITOR_RICHTEXT

See Also:

Constant Field Values

UI_EDITOR_WARNAREA

public static final int UI_EDITOR_WARNAREA

See Also:

Constant Field Values

UI_EDITOR_IMAGEMAPAREA

public static final int UI_EDITOR_IMAGEMAPAREA

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_RADIO

public static final int UI_EDITOR_ENUMERATE_RADIO

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_CHECK

public static final int UI_EDITOR_ENUMERATE_CHECK

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_LIST

public static final int UI_EDITOR_ENUMERATE_LIST

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_COMBO

public static final int UI_EDITOR_ENUMERATE_COMBO

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_BOOLEAN

public static final int UI_EDITOR_ENUMERATE_BOOLEAN

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_MEMBER

public static final int UI_EDITOR_ENUMERATE_MEMBER

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_GROUP

public static final int UI_EDITOR_ENUMERATE_GROUP

See Also:

Constant Field Values

UI_EDITOR_ENUMERATE_CATEGORIES

public static final int UI_EDITOR_ENUMERATE_CATEGORIES

See Also:

Constant Field Values

UI_EDITOR_QUERYCHOOSER

public static final int UI_EDITOR_QUERYCHOOSER

See Also:

Constant Field Values

UI_EDITOR_MEMBERCHOOSER

public static final int UI_EDITOR_MEMBERCHOOSER

See Also:

Constant Field Values

UI_EDITOR_MEMBERSCHOOSER

public static final int UI_EDITOR_MEMBERSCHOOSER

See Also:

Constant Field Values

UI_EDITOR_GROUPCHOOSER

public static final int UI_EDITOR_GROUPCHOOSER

See Also:

Constant Field Values

UI_EDITOR_GROUPSCHOOSER

public static final int UI_EDITOR_GROUPSCHOOSER

See Also:

Constant Field Values

UI_EDITOR_PUBLICATIONCHOOSER

public static final int UI_EDITOR_PUBLICATIONCHOOSER

See Also:

Constant Field Values

UI_EDITOR_PUBLICATIONSCHOOSER

public static final int UI_EDITOR_PUBLICATIONSCHOOSER

See Also:

Constant Field Values

UI_EDITOR_CATEGORYCHOOSER

public static final int UI_EDITOR_CATEGORYCHOOSER

See Also:

Constant Field Values

UI_EDITOR_CATEGORIESCHOOSER

public static final int UI_EDITOR_CATEGORIESCHOOSER

See Also:

Constant Field Values

UI_EDITOR_WORKSPACECHOOSER

public static final int UI_EDITOR_WORKSPACECHOOSER

See Also:

Constant Field Values

UI_EDITOR_DURATIONCHOOSER

public static final int UI_EDITOR_DURATIONCHOOSER

See Also:

Constant Field Values

UI_EDITOR_DATECHOOSER

public static final int UI_EDITOR_DATECHOOSER

See Also:

Constant Field Values

UI_EDITOR_SQLQUERY

public static final int UI_EDITOR_SQLQUERY

See Also:

Constant Field Values

UI_EDITOR_DBRECORDCHOOSER

public static final int UI_EDITOR_DBRECORDCHOOSER

See Also:

Constant Field Values

UI_EDITOR_CATEGORYTREE

public static final int UI_EDITOR_CATEGORYTREE

See Also:

Constant Field Values

UI_EDITOR_ACLCHOOSER

public static final int UI_EDITOR_ACLCHOOSER

See Also:

Constant Field Values

logger

protected static final org.apache.log4j.Logger logger

tabGroup

protected java.lang.String tabGroup

isTabbed

protected boolean isTabbed

label

protected java.lang.String label

description

protected java.lang.String description

placeholder

protected java.lang.String placeholder

widgetName

protected java.lang.String widgetName

widgetId

protected java.lang.String widgetId

values

protected java.lang.String[] values

valueMap

protected java.util.Map valueMap

defaultValue

protected java.lang.String defaultValue

firstInputID

protected java.lang.String firstInputID

multilingual

protected boolean multilingual

required

protected boolean required

keyword

protected boolean keyword

wrapper

protected java.lang.String wrapper

customAttributes

protected java.lang.String customAttributes

editorUI

protected int editorUI

descriptionUI

protected int descriptionUI

inline

protected boolean inline

itemCount

protected int itemCount

How many items this "list" widget is composed of

widgetAddCount

protected int widgetAddCount

css

protected java.lang.String css

showAddButton

protected boolean showAddButton

formName

protected java.lang.String formName

printSeparator

protected boolean printSeparator

printLabel

protected boolean printLabel

printWidget

protected boolean printWidget

hidden

protected boolean hidden

disabled

protected boolean disabled

languageList

protected java.util.List<java.lang.String> languageList

channel

protected Channel channel

tabIndex

protected int tabIndex

forceUpDown

protected boolean forceUpDown

context

protected JcmsJspContext context

userLang

protected java.lang.String userLang

hiddenActions

protected java.lang.String hiddenActions

showCreateIcons

protected boolean showCreateIcons

showSelectIcons

protected boolean showSelectIcons

showRemoveIcons

protected boolean showRemoveIcons

showTrashIcons

protected boolean showTrashIcons

showUpIcons

protected boolean showUpIcons

showDownIcons

protected boolean showDownIcons

showLeftIcons

protected boolean showLeftIcons

showRightIcons

protected boolean showRightIcons

showEditIcons

protected boolean showEditIcons

showAddIcons

protected boolean showAddIcons

showLinkID

protected boolean showLinkID

showCalendarIcons

protected boolean showCalendarIcons

showImageChooser

protected boolean showImageChooser

showDocChooser

protected boolean showDocChooser

showWebdavChooser

protected boolean showWebdavChooser

showMediaChooser

protected boolean showMediaChooser

showColorChooser

protected boolean showColorChooser

showDBRecChooser

protected boolean showDBRecChooser

showQueryChooser

protected boolean showQueryChooser

showMrbChooser

protected boolean showMrbChooser

showGrpChooser

protected boolean showGrpChooser

showCategoryButton

protected boolean showCategoryButton

Constructor Detail

AbstractWidget

public AbstractWidget()

Method Detail

getEditor

public static int getEditor(java.lang.String name)

getEditorName

public static java.lang.String getEditorName(int editor)

isEditorCtxMenu

public boolean isEditorCtxMenu(int editor)

Returns true if editor needs a ctxmenu

Parameters:

editor -

Returns:

true if the widget needs a ctxmenu

Since:

jcms-6.1.0

isTabbedEditor

public boolean isTabbedEditor(int editor)

getDescriptionName

public static java.lang.String getDescriptionName(int editor)

getWidgetEditor

protected java.lang.String getWidgetEditor(int count)

Print the Editor of the Widget

Returns:

HTML Representation

initWidget

public void initWidget()

Set local Attribute from attribute Map

getWidgetEditor

protected abstract java.lang.String getWidgetEditor(int count,
                               java.lang.String lang,
                               java.lang.String inputId)

getWidgetEditor

protected final java.lang.String getWidgetEditor(int count,
                               java.lang.String lang)

getInputId

protected java.lang.String getInputId(boolean first)

getComponentCount

protected int getComponentCount()

Returns the number of form elements (input, textarea, button,...).

Returns:

the number of form elements (input, textarea, button,...).

getAddComponentCount

protected int getAddComponentCount()

Return the number of additional form elements

Returns:

An int that represent the number of additional elements.

getTotalComponentCount

public int getTotalComponentCount()

Return the total of form element generated

Returns:

an int

getListWidgetEditor

protected java.lang.String getListWidgetEditor(int startingIndex,
                                   java.lang.String flag)

Print a list of widget

Parameters:

startingIndex - the index of the field (case of multilingual)

Returns:

the html representation

Since:

jcms-4.2

getListWidgetEditorByLI

protected java.lang.String getListWidgetEditorByLI(int startingIndex,
                                       java.lang.String flag)

Print a list of widget using an LI presentation

Parameters:

startingIndex - the index of the field (case of multilingual)

Returns:

the html representation

Since:

jcms-5.5.0

printTabbedFieldAndItemIcons

protected void printTabbedFieldAndItemIcons(java.lang.StringBuffer buffer,
                                int i,
                                int startingIndex,
                                int wdgIndex,
                                java.lang.String lang)

getListWidgetEditor

protected java.lang.String getListWidgetEditor(int startingIndex)

getWidgetHidden

protected java.lang.String getWidgetHidden()

Print all the values to hidden

Returns:

String representing the html

Since:

jcms-4.2

getWidgetTab

protected void getWidgetTab(java.lang.StringBuffer sb)

getWidgetTabAdd

protected void getWidgetTabAdd(java.lang.StringBuffer sb)

getMessage

public java.lang.String getMessage(java.lang.String msg)

Return a convenient i18n message.

Parameters:

msg - the message

Returns:

a translated message

getWidget

public java.lang.String getWidget()

Print the Widget

Returns:

HTML Representation

isMultivalued

public boolean isMultivalued()

Returns true if the widget is multivalued

Returns:

true if widget is multivalued

Since:

jcms-6.1.0

getWidgetLang

protected java.lang.String getWidgetLang()

getWidgetDescriptionTooltip

protected java.lang.String getWidgetDescriptionTooltip()

Print the Description of the Widget

Returns:

HTML Representation

getWidgetDescriptionText

protected java.lang.String getWidgetDescriptionText(boolean force)

getWidgetTitle

protected java.lang.String getWidgetTitle()

Print the Title of the Widget

Returns:

HTML Representation

getInputTitle

protected java.lang.String getInputTitle(int count,
                             java.lang.String lang)

Returns what has to be added as attribute in an input tag.

Parameters:

count - i-th occurrence of the input

lang - language code of the lang for the input

Returns:

what has to be added as attribute in an input tag.

isShowAddButton

public boolean isShowAddButton()

getShowAddButton

public boolean getShowAddButton()

setShowAddButton

public void setShowAddButton(boolean showAddButton)

getCss

public java.lang.String getCss()

setCss

public void setCss(java.lang.String css)

getKeyword

public boolean getKeyword()

setKeyword

public void setKeyword(boolean keyword)

isKeywordDisplay

public boolean isKeywordDisplay()

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

setPlaceholder

public void setPlaceholder(java.lang.String placeholder)

getPlaceholder

public java.lang.String getPlaceholder()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getWidgetName

public java.lang.String getWidgetName()

setWidgetName

public void setWidgetName(java.lang.String widgetName)

getFormName

public java.lang.String getFormName()

setFormName

public void setFormName(java.lang.String formName)

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getValues

public java.lang.String[] getValues()

isPrintSeparator

public boolean isPrintSeparator()

setPrintSeparator

public void setPrintSeparator(boolean printSeparator)

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean hidden)

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

setPrintLabel

public void setPrintLabel(boolean printLabel)

isPrintWidget

public boolean isPrintWidget()

setPrintWidget

public void setPrintWidget(boolean printWidget)

isMultilingual

public boolean isMultilingual()

setMultilingual

public void setMultilingual(boolean multilingual)

setLanguageList

public void setLanguageList(java.util.List<java.lang.String> languageList)

getWrapper

public java.lang.String getWrapper()

setWrapper

public void setWrapper(java.lang.String wrapper)

setCustomAttributes

public void setCustomAttributes(java.lang.String customAttributes)

getCustomAttributes

public java.lang.String getCustomAttributes()

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getDescriptionUI

public int getDescriptionUI()

setDescriptionUI

public void setDescriptionUI(int descriptionUI)

isInline

public boolean isInline()

setInline

public void setInline(boolean inline)

getEditorUI

public int getEditorUI()

setEditorUI

public void setEditorUI(int editorUI)

getWidgetAddCount

public int getWidgetAddCount()

setWidgetAddCount

public void setWidgetAddCount(int widgetAddCount)

setWidgetInitCount

public void setWidgetInitCount(int widgetInitCount)

getTabIndex

public int getTabIndex()

setTabIndex

public void setTabIndex(int tabIndex)

getContext

public JcmsJspContext getContext()

setContext

public void setContext(JcmsJspContext context)

getHiddenActions

public java.lang.String getHiddenActions()

setHiddenActions

public void setHiddenActions(java.lang.String hiddenActions)

Set the string which define which actions are hidden from this widget, where each letter is associated with one action: A - Add B - DBRecord chooser C - Create D - Down / Right E - Edit F - Color chooser G - Group Chooser H - Member Chooser I - Image Chooser (upload) J - K - Calendar L - Id (data link) M - Media chooser N - O - Q - Query chooser R - Remove S - Select (Pub Chooser) T - Trash U - Up / Left V - W - Webdav Chooser X - Doc Chooser Y - CategoryChooser Z - WorkspaceChooser

Parameters:

hiddenActions - a sequence of character representing actions icons to hide.

setValues

public void setValues(java.lang.Object values)

getAllValues

protected java.util.Collection getAllValues()

Return All the values from values[] or Map in a Collection always return a collection, never null

Returns:

Collection for the values

getValue

public java.lang.String getValue(int count,
                        java.lang.String def)

Return the value regarding the values[] or Map

Parameters:

count - the object position

def - the default value

Returns:

the String value

getTabGroup

public java.lang.String getTabGroup()

setTabGroup

public void setTabGroup(java.lang.String tabGroup)

setIsTabbed

public void setIsTabbed(boolean isTabbed)

convertObject

protected java.lang.String[] convertObject(java.lang.Object obj)

Try to convert an Object of Object[] to String[]

Parameters:

obj - the Object to convert

Returns:

the String[] representation