org.javlo.component.links

Class PageReferenceComponent

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.core.ComplexPropertiesLink

org.javlo.component.links.PageReferenceComponent

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IAction, IContentVisualComponent, IRestItem, ITaxonomyContainer

public class PageReferenceComponent
extends ComplexPropertiesLink
implements IAction, ITaxonomyContainer

list of links to a subset of pages.

exposed variable :

• inherited from AbstractVisualComponent
• PageStatus pagesStatus : root page of menu. See #getRootPage.
• PageBean pages : list of pages selected to display.
• String title : title of the page list. See getContentTitle()
• PageReferenceComponent comp : current component.
• String firstPage : first page rendered in xHTML.

Author:

pvandermaesen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageReferenceComponent.PageEvent
static class	PageReferenceComponent.PagesStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	MOUNT_FORMAT
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, HIDDEN, 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, 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
PageReferenceComponent()

Method Summary

Modifier and Type	Method and Description
protected boolean	filterPage(ContentContext ctx, MenuElement page, Collection<MenuElement> currentSelection, Collection<String> commands, String filter, boolean widthUnactive) filter the page
String	getActionGroupName() the group name of the action
protected Calendar	getBackDate(ContentContext ctx)
protected Calendar	getBackDateNullIfUndefined(ContentContext ctx)
protected String	getCompInputName()
int	getComplexityLevel(ContentContext ctx) return the complexity level of the component.
String	getContentAsText(ContentContext ctx) get the text of the component
String	getCSSClassName(ContentContext ctx)
static Integer	getCurrentMonth(javax.servlet.http.HttpSession session)
static Integer	getCurrentYear(javax.servlet.http.HttpSession session)
protected String	getDefaultSelectedInputName()
protected String	getDirectLinkInputName()
protected String	getDisplayAsInputName()
protected String	getDynamicOrderInput()
String	getEditXHTMLCode(ContentContext ctx)
protected String	getEventInputName()
String	getFontAwesome()
String	getHexColor() get the exadecimal color for representation of the component.
protected String	getInputFirstPageFull()
protected String	getIntranetModeInputName()
protected Object	getLock(ContentContext ctx)
protected int	getMaxNews()
protected String	getOnlyWithoutChildrenInputName()
protected String	getOrder()
protected String	getOrderInputName()
protected String	getPageDisplayedId(MenuElement page)
protected String	getPageId(MenuElement page)
int	getPageSize(ContentContext ctx)
protected String	getParentNode(ContentContext ctx)
protected String	getParentNodeInputName()
String	getPrefixViewXHTMLCode(ContentContext ctx) code for prefix the view XHTML code.
protected String	getReverseOrderInput()
int	getSearchLevel() return the level of the component is a search.
protected List<MenuElement>	getSelectedPages(ContentContext ctx, List<MenuElement> children)
protected Collection<String>	getSelectedTag(ContentContext ctx)
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	getStyleTitle(ContentContext ctx) return the title of the style choice.
String	getSuffixViewXHTMLCode(ContentContext ctx) code for sufix the view XHTML code.
protected String	getTagsInputName()
Set<String>	getTaxonomy()
protected String	getTimeSelectionInputName(String option)
String	getType() return the type of the element.
protected String	getWidthEmptyPageInputName()
void	init(ComponentBean bean, ContentContext newContext)
boolean	initContent(ContentContext ctx) init the content with a default value. sample : "lorem ipsum" for text component.
boolean	isContentCachable(ContentContext ctx) return the part of header needed for this component
boolean	isContentCachableByQuery(ContentContext ctx)
boolean	isContentTimeCachable(ContentContext ctx)
protected boolean	isDisplayFirstPage()
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.
protected boolean	isReverseOrder(ContentContext ctx)
protected boolean	isSessionTaxonomy(ContentContext ctx)
protected boolean	isUIFilterOnEditUsers(ContentContext ctx)
protected boolean	isUIFullDisplayFirstPage(ContentContext ctx)
protected boolean	isUILargeSorting(ContentContext ctx)
protected boolean	isUITimeSelection(ContentContext ctx)
static void	main(String[] args)
static String	performCalendar(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
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
static void	setCurrentMonth(javax.servlet.http.HttpSession session, int currentMonth)
static void	setCurrentYear(javax.servlet.http.HttpSession session, int currentYear)
protected void	setDisplayFirstPage(boolean value)
protected void	setDynamicOrder(boolean dynamicOrder)
protected void	setEventOnly(boolean onlyEvent)
protected void	setIntranetMode(boolean mode)
protected void	setOrder(String order)
protected void	setParentNode(String node)
protected void	setReverseOrder(boolean reverseOrder)
protected void	setSessionTaxonomy(boolean sessionTaxo)
protected void	setTag(String tag)

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

equals, getField, getField, getLinkLabelName, getLinkName, init, 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, getComponentBean, getComponentCSS, getComponentCssClass, getComponentId, getComponentLabel, getComponentPath, getConfig, getConfigMessage, getContainerPage, getContentAsMap, getContentCache, getContentMessage, getContentName, getContentTimeCache, getCookiesDisplayStatus, getCreationDate, getCSSStyle, getCurrentPage, getCurrentRenderer, getDebugHeader, getDefaultHelpURI, getDefaultRenderer, getDeleteDate, getDescription, 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, getListGroup, getListItemTag, getListTag, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssClass, getSpecialPreviewCssId, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getStyle, getStyleLabel, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getViewXHTMLCode, getWidth, getWordCount, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isColored, isConfig, isDefaultValue, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isInline, isInsertable, isList, isListable, 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, 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.actions.IAction

haveRight

Field Detail

MOUNT_FORMAT

public static final String MOUNT_FORMAT

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

PageReferenceComponent

public PageReferenceComponent()

Method Detail

getCurrentMonth

public static final Integer getCurrentMonth(javax.servlet.http.HttpSession session)

getCurrentYear

public static final Integer getCurrentYear(javax.servlet.http.HttpSession session)

performCalendar

public static final String performCalendar(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)

setCurrentMonth

public static final void setCurrentMonth(javax.servlet.http.HttpSession session,
                                         int currentMonth)

setCurrentYear

public static final void setCurrentYear(javax.servlet.http.HttpSession session,
                                        int currentYear)

filterPage

protected boolean filterPage(ContentContext ctx,
                             MenuElement page,
                             Collection<MenuElement> currentSelection,
                             Collection<String> commands,
                             String filter,
                             boolean widthUnactive)
                      throws Exception

filter the page

Parameters:

ctx - current contentcontext

page - a page

Returns:

true if page is accepted

Throws:

Exception

getBackDate

protected Calendar getBackDate(ContentContext ctx)

getBackDateNullIfUndefined

protected Calendar getBackDateNullIfUndefined(ContentContext ctx)

getCompInputName

protected String getCompInputName()

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

getCSSClassName

public String getCSSClassName(ContentContext ctx)

getDefaultSelectedInputName

protected String getDefaultSelectedInputName()

getDisplayAsInputName

protected String getDisplayAsInputName()

Overrides:

getDisplayAsInputName in class AbstractVisualComponent

isUITimeSelection

protected boolean isUITimeSelection(ContentContext ctx)

isUIFullDisplayFirstPage

protected boolean isUIFullDisplayFirstPage(ContentContext ctx)

isUIFilterOnEditUsers

protected boolean isUIFilterOnEditUsers(ContentContext ctx)

isUILargeSorting

protected boolean isUILargeSorting(ContentContext ctx)

getEditXHTMLCode

public String getEditXHTMLCode(ContentContext ctx)
                        throws Exception

Overrides:

getEditXHTMLCode in class AbstractVisualComponent

Throws:

Exception

See Also:

org.javlo.itf.IContentVisualComponent#getXHTMLCode()

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)

getMaxNews

protected int getMaxNews()

getOrder

protected String getOrder()

getOrderInputName

protected String getOrderInputName()

getDirectLinkInputName

protected String getDirectLinkInputName()

getPageId

protected String getPageId(MenuElement page)

getPageDisplayedId

protected String getPageDisplayedId(MenuElement page)

getSelectedPages

protected List<MenuElement> getSelectedPages(ContentContext ctx,
                                             List<MenuElement> children)
                                      throws Exception

Throws:

Exception

getParentNode

protected String getParentNode(ContentContext ctx)

getParentNodeInputName

protected String getParentNodeInputName()

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.

getReverseOrderInput

protected String getReverseOrderInput()

getDynamicOrderInput

protected String getDynamicOrderInput()

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.

getStyleTitle

public String getStyleTitle(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the title of the style choice.

Specified by:

getStyleTitle in interface IContentVisualComponent

Overrides:

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

getSelectedTag

protected Collection<String> getSelectedTag(ContentContext ctx)

getTagsInputName

protected String getTagsInputName()

isDisplayFirstPage

protected boolean isDisplayFirstPage()

setDisplayFirstPage

protected void setDisplayFirstPage(boolean value)

setIntranetMode

protected void setIntranetMode(boolean mode)

getInputFirstPageFull

protected String getInputFirstPageFull()

getTimeSelectionInputName

protected String getTimeSelectionInputName(String option)

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.

getWidthEmptyPageInputName

protected String getWidthEmptyPageInputName()

getOnlyWithoutChildrenInputName

protected String getOnlyWithoutChildrenInputName()

getEventInputName

protected String getEventInputName()

getIntranetModeInputName

protected String getIntranetModeInputName()

init

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

Overrides:

init in class AbstractVisualComponent

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 ComplexPropertiesLink

Returns:

isContentCachableByQuery

public boolean isContentCachableByQuery(ContentContext ctx)

Overrides:

isContentCachableByQuery in class AbstractVisualComponent

isContentTimeCachable

public boolean isContentTimeCachable(ContentContext ctx)

Overrides:

isContentTimeCachable in class AbstractVisualComponent

isReverseOrder

protected boolean isReverseOrder(ContentContext ctx)

isSessionTaxonomy

protected boolean isSessionTaxonomy(ContentContext ctx)

getPageSize

public int getPageSize(ContentContext ctx)

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

main

public static void main(String[] args)

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

setOrder

protected void setOrder(String order)

setSessionTaxonomy

protected void setSessionTaxonomy(boolean sessionTaxo)

setParentNode

protected void setParentNode(String node)

setReverseOrder

protected void setReverseOrder(boolean reverseOrder)

setEventOnly

protected void setEventOnly(boolean onlyEvent)

setDynamicOrder

protected void setDynamicOrder(boolean dynamicOrder)

setTag

protected void setTag(String tag)

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 ComplexPropertiesLink

Parameters:

ctx - current context

Returns:

getActionGroupName

public String getActionGroupName()

Description copied from interface: IAction

the group name of the action

Specified by:

getActionGroupName in interface IAction

Returns:

a group name.

getSearchLevel

public int getSearchLevel()

Description copied from interface: IContentVisualComponent

return the level of the component is a search.

Specified by:

getSearchLevel in interface IContentVisualComponent

Overrides:

getSearchLevel in class AbstractVisualComponent

Returns:

1-LOW 2-MIDDLE 3-HIGH

getLock

protected Object getLock(ContentContext ctx)

Overrides:

getLock in class AbstractVisualComponent

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

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:

getContentAsText

public String getContentAsText(ContentContext ctx)

Description copied from interface: IContentVisualComponent

get the text of the component

Specified by:

getContentAsText in interface IContentVisualComponent

Overrides:

getContentAsText in class AbstractVisualComponent

Returns:

getTaxonomy

public Set<String> getTaxonomy()

Specified by:

getTaxonomy in interface ITaxonomyContainer

getFontAwesome

public String getFontAwesome()

Specified by:

getFontAwesome in interface IContentVisualComponent

Overrides:

getFontAwesome in class ComplexPropertiesLink