Package org.javlo.component.links

Class SimpleInternalLink

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.core.ComplexPropertiesLink

org.javlo.component.links.SimpleInternalLink

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IContentVisualComponent, IInternalLink, IReverseLinkComponent, IRestItem

public class SimpleInternalLink
extends ComplexPropertiesLink
implements IInternalLink, IReverseLinkComponent

Author:

pvandermaesen

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	logger	create a static logger.
static String	TYPE

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

HEADER_V1_0, LABEL_KEY, LINK_KEY, properties

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, 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
SimpleInternalLink()

Method Summary

Modifier and Type	Method	Description
protected String	getEditXHTMLCode(ContentContext ctx)
String	getFontAwesome()
protected String	getForcedPrefixViewXHTMLCode(ContentContext ctx)
String	getHelpURI(ContentContext ctx)
String	getHexColor()	get the exadecimal color for representation of the component.
String	getLabel()
String	getLinkId()
String	getLinkText(ContentContext ctx)	this text must be replace with a link.
String	getLinkURL(ContentContext ctx)	return the link code (in HTML) with the link text in.
String	getListGroup()	return the name of group component.
protected String	getParam()
String	getReverseLinkName()
String	getSuffixViewXHTMLCode(ContentContext ctx)	code for sufix the view XHTML code.
protected String	getTag(ContentContext ctx)
String	getType()	return the type of the element.
String	getViewXHTMLCode(ContentContext ctx)
void	init(ComponentBean bean, ContentContext newContext)
boolean	initContent(ContentContext ctx)	init the content with a default value. sample : "lorem ipsum" for text component.
boolean	isInline()	check if the component can be inserd inline.
boolean	isListable()	you display the composant as a list (if you want)
boolean	isOnlyFirstOccurrence()	only modify the first occurrence on the page
boolean	isOnlyPreviousComponent()	change only the component juste before link component
boolean	isOnlyThisPage()	only if reverse link change text only on the same page than the component.
boolean	isReverseLink()	return true if the component must be use as reverselink.
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

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

equals, getField, getField, getLinkLabelName, getLinkName, init, isContentCachable, isRealContent, isValueTranslatable, reloadProperties, setField, setValue, storeProperties, transflateFrom

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

applyReplacement, cleanResources, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, drawColumn, 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, getForcedRenderer, getForcedSuffixViewXHTMLCode, getFormName, getGroup, getHeaderContent, getHelpText, getHelpType, getHelpURL, getI18nEditableKeys, getIcon, getId, getImportFolderPath, getImportFolderPath, getInlineStyle, getInputName, getInputNameColomn, getInputNameColomnStyle, getInputNameRenderer, getInputNameRendererTitle, getItalicAndStrongLanguageMarkerList, getJSOnSubmit, getKey, getLabelLevel, getLastSufix, getLayout, getListClass, getListItemTag, getListTag, getLocalMessage, getLock, getManualCssClass, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPrefixCssClass, getPrefixViewXHTMLCode, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getReferenceComponent, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSearchLevel, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getSpecificCssClass, getStyle, getStyleLabel, getStyleLabelList, getStyleList, getStyleTitle, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextPosition, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isCloseRow, isColored, isColumnable, isConfig, isContentCachableByQuery, isContentTimeCachable, isDefaultValue, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isHiddenInModeValue, isInsertable, isList, isMetaTitle, isMirroredByDefault, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isOpenRow, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isStyleHidden, isUnique, isValueProperties, 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, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML, toString, updateCache

Methods inherited from class java.lang.Object

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

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

getPage

Field Detail

logger

protected static Logger logger

create a static logger.

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

SimpleInternalLink

public SimpleInternalLink()

Method Detail

init

public void init(ComponentBean bean,
                 ContentContext newContext)
          throws Exception

Overrides:

init in class AbstractVisualComponent

Throws:

Exception

isInline

public boolean isInline()

Description copied from interface: IContentVisualComponent

check if the component can be inserd inline.

Specified by:

isInline in interface IContentVisualComponent

Overrides:

isInline in class AbstractVisualComponent

Returns:

true if component is a inline component. (text, link, image)...

getTag

protected String getTag(ContentContext ctx)

Overrides:

getTag in class AbstractVisualComponent

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

getForcedPrefixViewXHTMLCode

protected String getForcedPrefixViewXHTMLCode(ContentContext ctx)

Overrides:

getForcedPrefixViewXHTMLCode in class AbstractVisualComponent

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

See Also:

org.javlo.itf.IContentVisualComponent#getXHTMLCode()

getParam

protected String getParam()
                   throws Exception

Throws:

Exception

getLinkId

public String getLinkId()

Specified by:

getLinkId in interface IInternalLink

getLabel

public String getLabel()

getReverseLinkName

public String getReverseLinkName()

getEditXHTMLCode

protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception

Overrides:

getEditXHTMLCode in class AbstractVisualComponent

Throws:

Exception

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.

performEdit

public String performEdit(ContentContext ctx)

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

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)

isListable

public boolean isListable()

Description copied from interface: IContentVisualComponent

you display the composant as a list (if you want)

Specified by:

isListable in interface IContentVisualComponent

Overrides:

isListable in class AbstractVisualComponent

Returns:

true if a text is listable

getHelpURI

public String getHelpURI(ContentContext ctx)

Overrides:

getHelpURI in class AbstractVisualComponent

getLinkText

public String getLinkText(ContentContext ctx)

Description copied from interface: IReverseLinkComponent

this text must be replace with a link.

Specified by:

getLinkText in interface IReverseLinkComponent

Returns:

getLinkURL

public String getLinkURL(ContentContext ctx)

Description copied from interface: IReverseLinkComponent

return the link code (in HTML) with the link text in.

Specified by:

getLinkURL in interface IReverseLinkComponent

Returns:

isReverseLink

public boolean isReverseLink()

Description copied from interface: IReverseLinkComponent

return true if the component must be use as reverselink.

Specified by:

isReverseLink in interface IReverseLinkComponent

Returns:

isOnlyFirstOccurrence

public boolean isOnlyFirstOccurrence()

Description copied from interface: IReverseLinkComponent

only modify the first occurrence on the page

Specified by:

isOnlyFirstOccurrence in interface IReverseLinkComponent

isOnlyThisPage

public boolean isOnlyThisPage()

Description copied from interface: IReverseLinkComponent

only if reverse link change text only on the same page than the component.

Specified by:

isOnlyThisPage in interface IReverseLinkComponent

Returns:

isOnlyPreviousComponent

public boolean isOnlyPreviousComponent()

Description copied from interface: IReverseLinkComponent

change only the component juste before link component

Specified by:

isOnlyPreviousComponent in interface IReverseLinkComponent

Returns:

initContent

public boolean initContent(ContentContext ctx)
                    throws Exception

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.

Throws:

Exception

getListGroup

public String getListGroup()

Description copied from interface: IContentVisualComponent

return the name of group component.

Specified by:

getListGroup in interface IContentVisualComponent

Overrides:

getListGroup in class AbstractVisualComponent

Returns:

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class ComplexPropertiesLink