Package org.javlo.component.container

Class Box

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.container.Box

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IContainer, IContentVisualComponent, IRestItem

Direct Known Subclasses:

Section, TextDirection

public class Box
extends AbstractVisualComponent
implements IContainer

Field Summary

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.container.IContainer

CLOSE_BOX_ATTRIBUTE, CLOSE_CONTAINER_CODE, OPEN_CONTAINER_CODE

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
Box()

Method Summary

Modifier and Type	Method	Description
protected Stack<Character>	getBoxStack(ContentContext ctx)
protected String	getCloseBoxInputName()
String	getCloseCode(ContentContext ctx)	return the close code for the current component.
Box	getCloseComponent(ContentContext ctx)
protected Collection<String>	getColors()
protected String	getColorsBoxInputName()
protected String	getColumn(ContentContext ctx)
protected boolean	getColumnableDefaultValue()
int	getComplexityLevel(ContentContext ctx)	return the complexity level of the component.
String	getContainerColor()
String	getContainerLayout()
protected String	getCSSClass(ContentContext ctx)
protected String	getEditXHTMLCode(ContentContext ctx)
String	getFontAwesome()
protected String	getFooter()
protected String	getFooterBoxInputName()
protected String	getForcedPrefixViewXHTMLCode(ContentContext ctx)
protected String	getForcedSuffixViewXHTMLCode(ContentContext ctx)
String	getHexColor()	get the exadecimal color for representation of the component.
String	getHtmlId()
protected String	getIdBoxInputName()
protected String	getInternalPrefix(ContentContext ctx)
protected String	getInternalSuffix(ContentContext ctx)
protected String	getLayoutBoxInputName()
protected Collection<String>	getLayouts()
protected String	getManualId()
String	getOpenCode(ContentContext ctx)	get the container code "open code" for open component.
Box	getOpenComponent(ContentContext ctx)
String	getPrefixViewXHTMLCode(ContentContext ctx)	code for prefix the view XHTML code.
String[]	getStyleList(ContentContext ctx)	get the list of style possible for this component.
protected String	getTag()
String	getTitle()
protected String	getTitleBoxInputName()
String	getType()	return the type of the element.
String	getViewXHTMLCode(ContentContext ctx)
protected boolean	isBoxCloseRow(ContentContext ctx)
boolean	isCloseBox()
boolean	isContentCachable(ContentContext ctx)	return the part of header needed for this component
boolean	isDispayEmptyXHTMLCode(ContentContext ctx)	display empty xhtml code if empty
boolean	isOpen(ContentContext ctx)
String	performEdit(ContentContext ctx)	action call when update the content page.
void	prepareView(ContentContext ctx)	prepare the rendering of a component. default attributes put in request : style, value, type, compid
void	setOpen(ContentContext ctx, boolean open)

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, getColumnMaxSize, getColumnSize, getColumnSizes, getColumnStyle, 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, getForcedRenderer, 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, getStyleLabel, getStyleLabelList, getStyleTitle, getSuffixViewXHTMLCode, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextPosition, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, init, init, initContent, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isCloseRow, isColored, isColumnable, isConfig, isContentCachableByQuery, isContentTimeCachable, isDefaultValue, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isHiddenInModeValue, isInline, isInsertable, isList, isListable, isMetaTitle, isMirroredByDefault, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isOpenRow, isPreviousSame, isPreviousSame, isRealContent, isRepeat, isRepeatable, isRestMatch, isReversedLink, isStyleHidden, isUnique, isValueProperties, isValueTranslatable, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, markAsNew, newInstance, next, onStyleChange, performColumnable, performConfig, performUpdate, prepareEdit, 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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.javlo.component.container.IContainer

getId, getXHTMLCode

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

cleanResources, clearReplacement, delete, equals, extractFieldsFromRenderer, forceInit, getArea, getAuthors, getClassName, getColumnSize, getColumnStyle, getComponentBean, getComponentCssClass, getComponentLabel, getConfig, getConfigInValue, getConfigMessage, getContentAsText, getContentMessage, getContentName, getCreationDate, getCurrentRenderer, getDescription, getEditText, getEmptyXHTMLCode, getErrorMessage, getErrorMessage, getExternalModules, getExternalResources, getFirstPrefix, getGroup, getHeaderContent, getHelpText, getHelpURL, getI18nEditableKeys, getIcon, getInputNameRenderer, getJSOnSubmit, getKey, getLabelLevel, getLastSufix, getLayout, getListGroup, getMarkerList, getMessage, getModificationDate, getNextComponent, getPage, getPageDescription, getPreviousComponent, getReferenceComponent, getRenderer, getSearchLevel, getSpecialTagTitle, getSpecialTagXHTML, getStyle, getStyleLabel, getStyleLabelList, getStyleTitle, getSuffixViewXHTMLCode, getTextForSearch, getTextLabel, getTextMessage, getTextTitle, getTitleLevel, getValue, getVersion, getViewText, getWordCount, getXHTMLConfig, initContent, insert, isColumnable, isConfig, isDefaultValue, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstRepeated, isHelpURL, isHidden, isHiddenInMode, isInline, isInsertable, isList, isListable, isMetaTitle, isMirroredByDefault, isModify, isNeedRefresh, isNew, isNolink, isRealContent, isRepeat, isRepeatable, isRestMatch, isUnique, isVisible, isVisible, isVisibleFromCookies, loadViewData, markAsNew, newInstance, next, performConfig, previous, replaceAllInContent, replaceInContent, resetViewData, setColumnSize, setContainerPage, setDisplayHidden, setGroup, setList, setNeedRefresh, setNextComponent, setPage, setPreviousComponent, setRenderer, setRepeat, setStyle, setValid, setValue, stored, transflateFrom

Methods inherited from interface org.javlo.data.rest.IRestItem

getContentAsMap

Constructor Detail

Box

public Box()

Method Detail

getCloseBoxInputName

protected String getCloseBoxInputName()

getTitleBoxInputName

protected String getTitleBoxInputName()

getIdBoxInputName

protected String getIdBoxInputName()

getLayoutBoxInputName

protected String getLayoutBoxInputName()

getColorsBoxInputName

protected String getColorsBoxInputName()

getFooterBoxInputName

protected String getFooterBoxInputName()

getCSSClass

protected String getCSSClass(ContentContext ctx)

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.

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

Specified by:

prepareView in interface IContentVisualComponent

Overrides:

prepareView in class AbstractVisualComponent

Throws:

Exception

getOpenComponent

public Box getOpenComponent(ContentContext ctx)

Specified by:

getOpenComponent in interface IContainer

getCloseComponent

public Box getCloseComponent(ContentContext ctx)

Specified by:

getCloseComponent in interface IContainer

getHtmlId

public String getHtmlId()

getLayouts

protected Collection<String> getLayouts()

getColors

protected Collection<String> getColors()

getEditXHTMLCode

protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception

Overrides:

getEditXHTMLCode in class AbstractVisualComponent

Throws:

Exception

getTag

protected String getTag()

getType

public String getType()

Description copied from interface: IContentVisualComponent

return the type of the element.

Specified by:

getType in interface IContentVisualComponent

Returns:

the type of the element.

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.

getColumn

protected String getColumn(ContentContext ctx)

Overrides:

getColumn in class AbstractVisualComponent

getForcedPrefixViewXHTMLCode

protected String getForcedPrefixViewXHTMLCode(ContentContext ctx)

Overrides:

getForcedPrefixViewXHTMLCode in class AbstractVisualComponent

getForcedSuffixViewXHTMLCode

protected String getForcedSuffixViewXHTMLCode(ContentContext ctx)

Overrides:

getForcedSuffixViewXHTMLCode in class AbstractVisualComponent

isBoxCloseRow

protected boolean isBoxCloseRow(ContentContext ctx)

getInternalPrefix

protected String getInternalPrefix(ContentContext ctx)

getInternalSuffix

protected String getInternalSuffix(ContentContext ctx)

getBoxStack

protected Stack<Character> getBoxStack(ContentContext ctx)

getViewXHTMLCode

public String getViewXHTMLCode(ContentContext ctx)
                        throws Exception

Overrides:

getViewXHTMLCode in class AbstractVisualComponent

Throws:

Exception

isCloseBox

public boolean isCloseBox()

getTitle

public String getTitle()

getContainerLayout

public String getContainerLayout()

getContainerColor

public String getContainerColor()

getManualId

protected String getManualId()

getFooter

protected String getFooter()

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

setOpen

public void setOpen(ContentContext ctx,
                    boolean open)

Specified by:

setOpen in interface IContainer

getOpenCode

public String getOpenCode(ContentContext ctx)

Description copied from interface: IContainer

get the container code "open code" for open component.

Specified by:

getOpenCode in interface IContainer

Returns:

html code.

getCloseCode

public String getCloseCode(ContentContext ctx)

Description copied from interface: IContainer

return the close code for the current component.

Specified by:

getCloseCode in interface IContainer

Returns:

isOpen

public boolean isOpen(ContentContext ctx)

Specified by:

isOpen in interface IContainer

getComplexityLevel

public int getComplexityLevel(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the complexity level of the component.

Specified by:

getComplexityLevel in interface IContentVisualComponent

Overrides:

getComplexityLevel in class AbstractVisualComponent

Parameters:

ctx - TODO

Returns:

see contant

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)

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:

isDispayEmptyXHTMLCode

public boolean isDispayEmptyXHTMLCode(ContentContext ctx)
                               throws Exception

Description copied from interface: IContentVisualComponent

display empty xhtml code if empty

Specified by:

isDispayEmptyXHTMLCode in interface IContentVisualComponent

Overrides:

isDispayEmptyXHTMLCode in class AbstractVisualComponent

Returns:

Throws:

Exception

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class AbstractVisualComponent

getColumnableDefaultValue

protected boolean getColumnableDefaultValue()

Overrides:

getColumnableDefaultValue in class AbstractVisualComponent