Package org.javlo.component.links

Class SmartExternalLink

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.core.ComplexPropertiesLink

org.javlo.component.links.SmartExternalLink

All Implemented Interfaces:

Serializable, Comparable<IContentVisualComponent>, IContentVisualComponent, IReverseLinkComponent, IImageTitle, IRestItem

public class SmartExternalLink
extends ComplexPropertiesLink
implements IReverseLinkComponent, IImageTitle

Author:

pvandermaesen

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmartExternalLink.UndateInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	DESCRIPTION_KEY
protected static String	IMAGE_KEY
protected static String	IMAGE_LINK_KEY
protected static String	IMAGE_URI_KEY
protected static Logger	logger	create a static logger.
protected static String	RESPONSE_KEY
static String	STYLE_NORMAL
static String	STYLE_PRIORITY
protected static String	TITLE_KEY
static String	TYPE
protected static String	VALID_CONNECTION_KEY
protected static String	VALID_LINK

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

Fields inherited from interface org.javlo.component.image.IImageTitle

NO_LINK

Constructor Summary

Constructors

Constructor	Description
SmartExternalLink()

Method Summary

Modifier and Type	Method	Description
void	addRequestURL(ContentContext ctx, String url)
void	delete(ContentContext ctx)	this method is called when component is deleted.
protected void	deleteImage(ContentContext ctx)
int	getComplexityLevel(ContentContext ctx)	return the complexity level of the component.
protected String	getDescriptionInputName()
protected String	getEditXHTMLCode(ContentContext ctx)
String	getHexColor()	get the exadecimal color for representation of the component.
long	getImageCRC32(ContentContext ctx)
String	getImageDescription(ContentContext ctx)
protected String	getImageLink()
String	getImageLinkURL(ContentContext ctx)
String	getImageURI(ContentContext ctx)
String	getLabel(ContentContext ctx)
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.
int	getPriority(ContentContext ctx)	return the priority of the picture inside the page (9=max)
String	getResourceURL(ContentContext ctx)
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	getTitle(ContentContext ctx)
protected String	getTitleInputName()
String	getType()	return the type of the element.
String	getViewXHTMLCode(ContentContext ctx)
int	getWordCount(ContentContext ctx)	count the word in the content.
void	init(ComponentBean bean, ContentContext newContext)
protected boolean	isContentValid(ContentContext ctx, String pageContent)
boolean	isDisplayable(ContentContext ctx)	true if the component can be displayed in preview mode
boolean	isImageValid(ContentContext ctx)
boolean	isInline()	check if the component can be inserd inline.
boolean	isListable()	you display the composant as a list (if you want)
boolean	isMobileOnly(ContentContext ctx)
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.
boolean	isURLinRequest(ContentContext ctx, String url)
Boolean	isValidConnection(ContentContext ctx)
protected void	loadData(ContentContext ctx)
boolean	mustBeRemoved(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
protected void	refreshAutoInfo(ContentContext ctx)
void	removeValidConnection(ContentContext ctx)
void	setDescription(ContentContext ctx, String desc)
void	setImageCRC32(ContentContext ctx, long mustBeRemoved)
void	setImageURI(ContentContext ctx, String uri)
void	setLinkValid(ContentContext ctx, boolean visible)
void	setMustBeRemoved(ContentContext ctx, boolean mustBeRemoved)
void	setTitle(ContentContext ctx, String title)
void	setValidConnection(ContentContext ctx, boolean isValid)

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

equals, getField, getField, getFontAwesome, 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, deleteMySelf, drawColumn, equals, executeCurrentRenderer, executeJSP, executeRenderer, executeRenderer, extractFieldsFromRenderer, forceInit, getAjaxId, getArea, getAuthors, getBackgroundColor, getBaseHelpURL, getClassName, getColomnablePrefix, getColomnableSuffix, getColumn, getColumnableDefaultValue, 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, 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, getPrefixViewXHTMLCode, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getReferenceComponent, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSearchLevel, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getSpecificCssClass, getStyle, getStyleLabel, getStyleTitle, getSuffixViewXHTMLCode, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextPosition, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, initContent, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isCloseRow, isColored, isColumnable, isConfig, isContentCachableByQuery, isContentTimeCachable, isDefaultValue, isDispayEmptyXHTMLCode, 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

IMAGE_LINK_KEY

protected static final String IMAGE_LINK_KEY

See Also:

Constant Field Values

STYLE_NORMAL

public static final String STYLE_NORMAL

See Also:

Constant Field Values

STYLE_PRIORITY

public static final String STYLE_PRIORITY

See Also:

Constant Field Values

logger

protected static Logger logger

create a static logger.

TITLE_KEY

protected static final String TITLE_KEY

See Also:

Constant Field Values

DESCRIPTION_KEY

protected static final String DESCRIPTION_KEY

See Also:

Constant Field Values

IMAGE_URI_KEY

protected static final String IMAGE_URI_KEY

See Also:

Constant Field Values

IMAGE_KEY

protected static final String IMAGE_KEY

See Also:

Constant Field Values

RESPONSE_KEY

protected static final String RESPONSE_KEY

See Also:

Constant Field Values

VALID_CONNECTION_KEY

protected static final String VALID_CONNECTION_KEY

See Also:

Constant Field Values

VALID_LINK

protected static final String VALID_LINK

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

SmartExternalLink

public SmartExternalLink()

Method Detail

addRequestURL

public void addRequestURL(ContentContext ctx,
                          String url)

delete

public void delete(ContentContext ctx)

Description copied from interface: IContentVisualComponent

this method is called when component is deleted.

Specified by:

delete in interface IContentVisualComponent

Overrides:

delete in class AbstractVisualComponent

deleteImage

protected void deleteImage(ContentContext ctx)
                    throws IOException

Throws:

IOException

getDescriptionInputName

protected String getDescriptionInputName()

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)

getImageCRC32

public long getImageCRC32(ContentContext ctx)
                   throws IOException

Throws:

IOException

getImageDescription

public String getImageDescription(ContentContext ctx)

Specified by:

getImageDescription in interface IImageTitle

getImageLink

protected String getImageLink()

getImageURI

public String getImageURI(ContentContext ctx)
                   throws IOException

Throws:

IOException

getResourceURL

public String getResourceURL(ContentContext ctx)

Specified by:

getResourceURL in interface IImageTitle

getLabel

public String getLabel(ContentContext ctx)
                throws IOException

Throws:

IOException

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:

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.

getTitle

public String getTitle(ContentContext ctx)
                throws IOException

Throws:

IOException

getTitleInputName

protected String getTitleInputName()

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

Specified by:

prepareView in interface IContentVisualComponent

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

getWordCount

public int getWordCount(ContentContext ctx)

Description copied from interface: IContentVisualComponent

count the word in the content.

Specified by:

getWordCount in interface IContentVisualComponent

Overrides:

getWordCount in class AbstractVisualComponent

Returns:

init

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

Overrides:

init in class AbstractVisualComponent

Throws:

Exception

isContentValid

protected boolean isContentValid(ContentContext ctx,
                                 String pageContent)

isDisplayable

public boolean isDisplayable(ContentContext ctx)
                      throws IOException

Description copied from interface: IContentVisualComponent

true if the component can be displayed in preview mode

Specified by:

isDisplayable in interface IContentVisualComponent

Overrides:

isDisplayable in class AbstractVisualComponent

Returns:

Throws:

IOException

isImageValid

public boolean isImageValid(ContentContext ctx)

Specified by:

isImageValid in interface IImageTitle

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

isOnlyPreviousComponent

public boolean isOnlyPreviousComponent()

Description copied from interface: IReverseLinkComponent

change only the component juste before link component

Specified by:

isOnlyPreviousComponent in interface IReverseLinkComponent

Returns:

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:

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:

isURLinRequest

public boolean isURLinRequest(ContentContext ctx,
                              String url)

isValidConnection

public Boolean isValidConnection(ContentContext ctx)
                          throws IOException

Throws:

IOException

loadData

protected void loadData(ContentContext ctx)
                 throws IOException

Throws:

IOException

mustBeRemoved

public boolean mustBeRemoved(ContentContext ctx)
                      throws IOException

Throws:

IOException

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

refreshAutoInfo

protected void refreshAutoInfo(ContentContext ctx)
                        throws Exception

Throws:

Exception

removeValidConnection

public void removeValidConnection(ContentContext ctx)
                           throws IOException

Throws:

IOException

setDescription

public void setDescription(ContentContext ctx,
                           String desc)
                    throws IOException

Throws:

IOException

setImageCRC32

public void setImageCRC32(ContentContext ctx,
                          long mustBeRemoved)
                   throws IOException

Throws:

IOException

setImageURI

public void setImageURI(ContentContext ctx,
                        String uri)
                 throws IOException

Throws:

IOException

setLinkValid

public void setLinkValid(ContentContext ctx,
                         boolean visible)
                  throws IOException

Throws:

IOException

setMustBeRemoved

public void setMustBeRemoved(ContentContext ctx,
                             boolean mustBeRemoved)
                      throws IOException

Throws:

IOException

setTitle

public void setTitle(ContentContext ctx,
                     String title)
              throws IOException

Throws:

IOException

setValidConnection

public void setValidConnection(ContentContext ctx,
                               boolean isValid)
                        throws IOException

Throws:

IOException

getImageLinkURL

public String getImageLinkURL(ContentContext ctx)

Specified by:

getImageLinkURL in interface IImageTitle

getPriority

public int getPriority(ContentContext ctx)

Description copied from interface: IImageTitle

return the priority of the picture inside the page (9=max)

Specified by:

getPriority in interface IImageTitle

Returns:

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

isMobileOnly

public boolean isMobileOnly(ContentContext ctx)

Specified by:

isMobileOnly in interface IImageTitle