Package org.javlo.component.meta

Class ToTheTopComponent

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.meta.ToTheTopComponent

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IContentVisualComponent, IRestItem

public class ToTheTopComponent
extends AbstractVisualComponent

Author:

pvandermaesen

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE

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

CACHE_KEY_SUFFIX_PARAM_NAME, COMPONENT_KEY, config, EDIT_CLASS, FLUID_COL_SIZE, FORCE_COMPONENT_ID, HIDDEN, I18N_FILE, logger, MAX_COL_VALUE, MOBILE_TYPE, 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	Description
ToTheTopComponent()

Method Summary

Modifier and Type	Method	Description
Date	getDate()
protected String	getEditXHTMLCode(ContentContext ctx)
String	getFontAwesome()
String	getHexColor()	get the exadecimal color for representation of the component.
String	getInputDateName()
String	getInputTimeName()
int	getPower()
String	getPrefixViewXHTMLCode(ContentContext ctx)	code for prefix the view XHTML code.
String	getStyleLabel(ContentContext ctx)	get the label of the current style
String[]	getStyleList(ContentContext ctx)	get the list of style possible for this component.
String	getSuffixViewXHTMLCode(ContentContext ctx)	code for sufix the view XHTML code.
String	getType()	return the type of the element.
String	getViewXHTMLCode(ContentContext ctx)
protected void	init()
boolean	isContentCachable(ContentContext ctx)	return the part of header needed for this component
boolean	isDefaultValue(ContentContext ctx)	return true if value is never modified.
boolean	isMirroredByDefault(ContentContext ctx)	if this component is duplicated, by default it is mirrored.
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.
String	performEdit(ContentContext ctx)	action call when update the content page.
void	setDate(Date date)

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

applyReplacement, cleanResources, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, drawColumn, equals, equals, executeCurrentRenderer, executeJSP, executeRenderer, executeRenderer, extractFieldsFromRenderer, forceInit, getAjaxId, getArea, getAuthors, getBackgroundColor, getBaseHelpURL, getClassName, getColomnablePrefix, getColomnableSuffix, getColumn, getColumnableDefaultValue, getColumnMaxSize, getColumnSize, getColumnSizes, getColumnStyle, getComplexityLevel, getComponentBean, getComponentCSS, getComponentCssClass, getComponentId, getComponentLabel, getComponentPath, getConfig, getConfigInValue, getConfigMessage, getContainerPage, getContentAsMap, getContentAsText, getContentCache, getContentMessage, getContentName, getContentTimeCache, getCookiesDisplayStatus, getCreationDate, getCSSStyle, getCurrentPage, getCurrentRenderer, getDataAttributes, getDebugHeader, getDefaultHelpURI, getDefaultRenderer, getDeleteDate, getDescription, getDisplayAsInputName, getDisplayMessage, getEditorComplexity, getEditRenderer, getEditText, getEmptyCode, getEmptyXHTMLCode, getErrorMessage, getErrorMessage, getExternalModules, getExternalResources, getFileDirectory, getFirstPrefix, getForcedId, getForcedPrefixViewXHTMLCode, getForcedRenderer, getForcedSuffixViewXHTMLCode, getFormName, getGroup, getHeaderContent, getHelpText, getHelpType, getHelpURI, getHelpURL, getI18nEditableKeys, getIcon, getId, getImportFolderPath, getImportFolderPath, getInlineStyle, getInputName, getInputNameColomn, getInputNameColomnStyle, getInputNameRenderer, getInputNameRendererTitle, getItalicAndStrongLanguageMarkerList, getJSOnSubmit, getKey, getLabelLevel, getLastSufix, getLayout, getListClass, getListGroup, getListItemTag, getListTag, getLocalMessage, getLock, getManualCssClass, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPrefixCssClass, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getReferenceComponent, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSearchLevel, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getSpecificCssClass, getStyle, getStyleLabelList, getStyleTitle, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextPosition, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, init, initContent, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isCloseRow, isColored, isColumnable, isConfig, isContentCachableByQuery, isContentTimeCachable, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isHiddenInModeValue, isInline, isInsertable, isList, isListable, isMetaTitle, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isOpenRow, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isStyleHidden, isUnique, isValueProperties, isValueTranslatable, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, markAsNew, newInstance, next, onStyleChange, performColumnable, performConfig, performUpdate, prepareEdit, prepareView, previous, processView, renderOtherComponent, renderViewXHTMLCode, replaceAllInContent, replaceInContent, resetContentCache, resetViewData, setBackgroundColor, setColumnSize, setColumnStyle, setComponentBean, setContainerPage, setContentCache, setContentTimeCache, setDisplayHidden, setForcedId, setForcedRenderer, setGroup, setHidden, setHiddenInMode, setList, setLocalMessage, setMessage, setMirrorWrapped, setModify, setNeedRefresh, setNextComponent, setNolink, setPage, setPreviousComponent, setRenderer, setRepeat, setStyle, setTextColor, setTextPosition, setValid, setValue, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML, toString, transflateFrom, updateCache

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

ToTheTopComponent

public ToTheTopComponent()

Method Detail

getType

public String getType()

Description copied from interface: IContentVisualComponent

return the type of the element.

Returns:

the type of the element.

init

protected void init()
             throws ResourceNotFoundException

Overrides:

init in class AbstractVisualComponent

Throws:

ResourceNotFoundException

getInputDateName

public String getInputDateName()

getInputTimeName

public String getInputTimeName()

getStyleLabel

public String getStyleLabel(ContentContext ctx)

Description copied from interface: IContentVisualComponent

get the label of the current style

Specified by:

getStyleLabel in interface IContentVisualComponent

Overrides:

getStyleLabel in class AbstractVisualComponent

Returns:

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.

getEditXHTMLCode

protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception

Overrides:

getEditXHTMLCode in class AbstractVisualComponent

Throws:

Exception

getDate

public Date getDate()

setDate

public void setDate(Date date)

getPrefixViewXHTMLCode

public String getPrefixViewXHTMLCode(ContentContext ctx)

Description copied from interface: IContentVisualComponent

code for prefix the view XHTML code.

Specified by:

getPrefixViewXHTMLCode in interface IContentVisualComponent

Overrides:

getPrefixViewXHTMLCode in class AbstractVisualComponent

Returns:

XHTML code.

getSuffixViewXHTMLCode

public String getSuffixViewXHTMLCode(ContentContext ctx)

Description copied from interface: IContentVisualComponent

code for sufix the view XHTML code.

Specified by:

getSuffixViewXHTMLCode in interface IContentVisualComponent

Overrides:

getSuffixViewXHTMLCode in class AbstractVisualComponent

Returns:

XHTML code.

getViewXHTMLCode

public String getViewXHTMLCode(ContentContext ctx)
                        throws Exception

Overrides:

getViewXHTMLCode in class AbstractVisualComponent

Throws:

Exception

isDefaultValue

public boolean isDefaultValue(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return true if value is never modified.

Specified by:

isDefaultValue in interface IContentVisualComponent

Overrides:

isDefaultValue in class AbstractVisualComponent

Returns:

true if value contain default value.

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)

performEdit

public String performEdit(ContentContext ctx)
                   throws Exception

Description copied from interface: IContentVisualComponent

action call when update the content page.

Specified by:

performEdit in interface IContentVisualComponent

Overrides:

performEdit in class AbstractVisualComponent

Returns:

the error message, null if no error

Throws:

Exception

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:

isMirroredByDefault

public boolean isMirroredByDefault(ContentContext ctx)

Description copied from interface: IContentVisualComponent

if this component is duplicated, by default it is mirrored.

Specified by:

isMirroredByDefault in interface IContentVisualComponent

Overrides:

isMirroredByDefault in class AbstractVisualComponent

Returns:

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:

getPower

public int getPower()

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class AbstractVisualComponent