org.javlo.component.links

Class InternalLink

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.core.ComplexPropertiesLink

org.javlo.component.links.InternalLink

All Implemented Interfaces:

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

Direct Known Subclasses:

UnsubsribeLink

public class InternalLink
extends ComplexPropertiesLink
implements IInternalLink, IReverseLinkComponent, ILink

Author:

pvandermaesen

Field Summary

Fields

Modifier and Type	Field and 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, FORCE_COMPONENT_ID, I18N_FILE, 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
InternalLink()

Method Summary

Modifier and Type	Method and Description
protected String	getEditXHTMLCode(ContentContext ctx)
String	getFontAwesome()
String	getHexColor() get the exadecimal color for representation of the component.
String	getLabel()
Date	getLatestValidDate()
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 Object	getLock(ContentContext ctx)
protected String	getParam()
String	getReverseLinkName()
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	getType() return the type of the element.
String	getURL(ContentContext ctx) generate a URL or URI link with all elements to click on.
String	getViewXHTMLCode(ContentContext ctx)
void	init(ComponentBean bean, ContentContext newContext)
boolean	isInline() check if the component can be inserd inline.
boolean	isLinkValid(ContentContext ctx) return true if the link on the component is enabled
boolean	isListable() you display the composant as a list (if you want)
boolean	isMirroredByDefault(ContentContext ctx) if this component is duplicated, by default it is mirrored.
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
void	setLatestValidDate(Date date)

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

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

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

applyReplacement, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, 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, getEditorComplexity, getEditText, 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, getListItemTag, getListTag, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPrefixViewXHTMLCode, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSearchLevel, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssClass, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getStyle, getStyleLabel, getStyleTitle, getSuffixViewXHTMLCode, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, initContent, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isColored, isConfig, isContentCachableByQuery, isContentTimeCachable, isDefaultValue, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isInsertable, isList, isMetaTitle, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isUnique, isValueProperties, isValueTranslatable, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, main, markAsNew, newInstance, next, onStyleChange, performConfig, 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, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML, transflateFrom

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, 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

InternalLink

public InternalLink()

Method Detail

getEditXHTMLCode

protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception

Overrides:

getEditXHTMLCode in class AbstractVisualComponent

Throws:

Exception

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)

getLabel

public String getLabel()

getLinkId

public String getLinkId()

Specified by:

getLinkId in interface IInternalLink

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:

getParam

protected String getParam()
                   throws Exception

Throws:

Exception

getReverseLinkName

public String getReverseLinkName()

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.

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.

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

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)...

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

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:

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:

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

getURL

public String getURL(ContentContext ctx)
              throws Exception

Description copied from interface: ILink

generate a URL or URI link with all elements to click on.

Specified by:

getURL in interface ILink

Returns:

Throws:

Exception

isLinkValid

public boolean isLinkValid(ContentContext ctx)
                    throws Exception

Description copied from interface: ILink

return true if the link on the component is enabled

Specified by:

isLinkValid in interface ILink

Returns:

Throws:

Exception

getLock

protected Object getLock(ContentContext ctx)

Overrides:

getLock in class AbstractVisualComponent

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:

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:

setLatestValidDate

public void setLatestValidDate(Date date)

Specified by:

setLatestValidDate in interface ILink

getLatestValidDate

public Date getLatestValidDate()

Specified by:

getLatestValidDate in interface ILink

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class ComplexPropertiesLink