org.javlo.component.text

Class Description

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.text.Description

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IContentVisualComponent, IRestItem

public class Description
extends AbstractVisualComponent

Author:

pvandermaesen

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Fields inherited from class org.javlo.component.core.AbstractVisualComponent

CACHE_KEY_SUFFIX_PARAM_NAME, COMPONENT_KEY, config, EDIT_CLASS, FORCE_COMPONENT_ID, HIDDEN, I18N_FILE, logger, NOT_EDIT_PREVIEW_PARAM_NAME, SCROLL_TO_COMP_ID_ATTRIBUTE_NAME, TIME_CACHE_NAME, VALUE_SEPARATOR

Fields inherited from interface org.javlo.component.core.IContentVisualComponent

COLORED_WRAPPER_CLASS, COMP_ID_REQUEST_PARAM, COMPLEXITY_ADMIN, COMPLEXITY_EASY, COMPLEXITY_STANDARD, CONTAINER_COLOR, DEFAULT_COLOR, DYN_COMP_COLOR, ECOM_COLOR, EDIT_ACTION_CSS_CLASS, GRAPHIC_COLOR, HIGH_LABEL_LEVEL, ID_SEPARATOR, LINK_COLOR, LOW_LABEL_LEVEL, META_COLOR, MIDDLE_LABEL_LEVEL, SEARCH_LEVEL_HIGH, SEARCH_LEVEL_LOW, SEARCH_LEVEL_MIDDLE, SEARCH_LEVEL_NONE, TEXT_COLOR, VIEW_DEFINITION_REQUEST_ID, WEB2_COLOR

Constructor Summary

Constructors

Constructor and Description
Description()

Method Summary

Modifier and Type	Method and Description
protected String	getEditorComplexity(ContentContext ctx) return the wysiwyg editor complexity
String	getFontAwesome()
String	getHexColor() get the exadecimal color for representation of the component.
List<SuffixPrefix>	getMarkerList(ContentContext ctx) return the title of the style choice.
String	getPageDescription(ContentContext ctx) return the description of the page if this component is or contains description.
int	getSearchLevel() return the level of the component is a search.
String[]	getStyleLabelList(ContentContext ctx) return a list of label define the style.
String[]	getStyleList(ContentContext ctx) get the list of style possible for this component.
String	getStyleTitle(ContentContext ctx) return the title of the style choice.
String	getTag(ContentContext ctx)
String	getType() return the type of the element.
String	getViewXHTMLCode(ContentContext ctx)
boolean	initContent(ContentContext ctx) init the content with a default value. sample : "lorem ipsum" for text component.
boolean	isContentCachable(ContentContext ctx) return the part of header needed for this component
boolean	isRealContent(ContentContext ctx) return true if component is considered as realContent and the page that contain the component is also considered as real content.
boolean	isUnique() return true if the component must be unique on a page
protected boolean	isValueTranslatable()
void	prepareView(ContentContext ctx) prepare the rendering of a component. default attributes put in request : style, value, type, compid
boolean	transflateFrom(ContentContext ctx, ITranslator translator, String lang) translate the content of the component to the current language

Methods inherited from class org.javlo.component.core.AbstractVisualComponent

applyReplacement, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, equals, equals, executeCurrentRenderer, executeJSP, executeRenderer, executeRenderer, extractFieldsFromRenderer, getAjaxId, getArea, getAuthors, getBackgroundColor, getBaseHelpURL, getClassName, getComplexityLevel, getComponentBean, getComponentCSS, getComponentCssClass, getComponentId, getComponentLabel, getComponentPath, getConfig, getConfigMessage, getContainerPage, getContentAsMap, getContentAsText, getContentCache, getContentMessage, getContentName, getContentTimeCache, getCookiesDisplayStatus, getCreationDate, getCSSStyle, getCurrentPage, getCurrentRenderer, getDebugHeader, getDefaultHelpURI, getDefaultRenderer, getDeleteDate, getDescription, getDisplayAsInputName, getDisplayMessage, getEditText, getEditXHTMLCode, getEmptyCode, getEmptyXHTMLCode, getErrorMessage, getErrorMessage, getExternalResources, getFirstPrefix, getForcedId, getForcedPrefixViewXHTMLCode, getForcedSuffixViewXHTMLCode, getFormName, getHeaderContent, getHelpType, getHelpURI, getHelpURL, getI18nEditableKeys, getId, getImportFolderPath, getImportFolderPath, getInlineStyle, getInputName, getInputNameRenderer, getInputNameRendererTitle, getItalicAndStrongLanguageMarkerList, getJSOnSubmit, getKey, getLabelLevel, getLastSufix, getLayout, getListClass, getListGroup, getListItemTag, getListTag, getLock, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPrefixViewXHTMLCode, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssClass, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getStyle, getStyleLabel, getSuffixViewXHTMLCode, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, init, init, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isColored, isConfig, isContentCachableByQuery, isContentTimeCachable, isDefaultValue, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isInline, isInsertable, isList, isListable, isMetaTitle, isMirroredByDefault, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isValueProperties, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, main, markAsNew, newInstance, next, onStyleChange, performConfig, performEdit, performUpdate, previous, processView, renderViewXHTMLCode, replaceAllInContent, replaceInContent, resetContentCache, resetViewData, setBackgroundColor, setComponentBean, setContainerPage, setContentCache, setContentTimeCache, setDisplayHidden, setForcedId, setHidden, setHiddenInMode, setList, setMessage, setMirrorWrapped, setModify, setNeedRefresh, setNextComponent, setNolink, setPage, setPreviousComponent, setRenderer, setRepeat, setStyle, setTextColor, setValid, setValue, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

Description

public Description()

Method Detail

getHexColor

public String getHexColor()

Description copied from interface: IContentVisualComponent

get the exadecimal color for representation of the component.

Specified by:

getHexColor in interface IContentVisualComponent

Overrides:

getHexColor in class AbstractVisualComponent

Returns:

a exadecimal color (sample : a5b499)

getSearchLevel

public int getSearchLevel()

Description copied from interface: IContentVisualComponent

return the level of the component is a search.

Specified by:

getSearchLevel in interface IContentVisualComponent

Overrides:

getSearchLevel in class AbstractVisualComponent

Returns:

1-LOW 2-MIDDLE 3-HIGH

getMarkerList

public List<SuffixPrefix> getMarkerList(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the title of the style choice.

Specified by:

getMarkerList in interface IContentVisualComponent

Overrides:

getMarkerList in class AbstractVisualComponent

getTag

public String getTag(ContentContext ctx)

Overrides:

getTag in class AbstractVisualComponent

getEditorComplexity

protected String getEditorComplexity(ContentContext ctx)

Description copied from class: AbstractVisualComponent

return the wysiwyg editor complexity

Overrides:

getEditorComplexity in class AbstractVisualComponent

Returns:

null if no wysywig editor

getStyleLabelList

public String[] getStyleLabelList(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return a list of label define the style.

Specified by:

getStyleLabelList in interface IContentVisualComponent

Overrides:

getStyleLabelList in class AbstractVisualComponent

Returns:

a list of label.

getStyleList

public String[] getStyleList(ContentContext ctx)

Description copied from interface: IContentVisualComponent

get the list of style possible for this component.

Specified by:

getStyleList in interface IContentVisualComponent

Overrides:

getStyleList in class AbstractVisualComponent

Returns:

a list of string represent a style.

getStyleTitle

public String getStyleTitle(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the title of the style choice.

Specified by:

getStyleTitle in interface IContentVisualComponent

Overrides:

getStyleTitle in class AbstractVisualComponent

getType

public String getType()

Description copied from interface: IContentVisualComponent

return the type of the element.

Returns:

the type of the element.

prepareView

public void prepareView(ContentContext ctx)
                 throws Exception

Description copied from class: AbstractVisualComponent

prepare the rendering of a component. default attributes put in request : style, value, type, compid

Overrides:

prepareView in class AbstractVisualComponent

Throws:

Exception

getViewXHTMLCode

public String getViewXHTMLCode(ContentContext ctx)
                        throws Exception

Overrides:

getViewXHTMLCode in class AbstractVisualComponent

Throws:

Exception

See Also:

org.javlo.itf.IContentVisualComponent#getXHTMLCode()

isRealContent

public boolean isRealContent(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return true if component is considered as realContent and the page that contain the component is also considered as real content.

Specified by:

isRealContent in interface IContentVisualComponent

Overrides:

isRealContent in class AbstractVisualComponent

Parameters:

ctx - current context

Returns:

initContent

public boolean initContent(ContentContext ctx)

Description copied from interface: IContentVisualComponent

init the content with a default value. sample : "lorem ipsum" for text component.

Specified by:

initContent in interface IContentVisualComponent

Overrides:

initContent in class AbstractVisualComponent

Returns:

true if content is create.

isUnique

public boolean isUnique()

Description copied from interface: IContentVisualComponent

return true if the component must be unique on a page

Specified by:

isUnique in interface IContentVisualComponent

Overrides:

isUnique in class AbstractVisualComponent

Returns:

isContentCachable

public boolean isContentCachable(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the part of header needed for this component

Specified by:

isContentCachable in interface IContentVisualComponent

Overrides:

isContentCachable in class AbstractVisualComponent

Returns:

getPageDescription

public String getPageDescription(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the description of the page if this component is or contains description.

Specified by:

getPageDescription in interface IContentVisualComponent

Overrides:

getPageDescription in class AbstractVisualComponent

Returns:

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class AbstractVisualComponent

isValueTranslatable

protected boolean isValueTranslatable()

Overrides:

isValueTranslatable in class AbstractVisualComponent

transflateFrom

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

Description copied from interface: IContentVisualComponent

translate the content of the component to the current language

Specified by:

transflateFrom in interface IContentVisualComponent

Overrides:

transflateFrom in class AbstractVisualComponent

Parameters:

ctx - contextContext of the current rendering

translator - class to translate

lang - the language of the current content (source language)

Returns: