java.lang.Object
- org.javlo.navigation.MenuElement

All Implemented Interfaces:

Serializable, IRestItem, ITaxonomyContainer, IPrintInfo

Direct Known Subclasses:

RootMenuElement
```
public class MenuElement
extends Object
implements Serializable, IPrintInfo, IRestItem, ITaxonomyContainer
```
Author:

pvanderm

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class MenuElement.SmartPageDescription

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`INSTANCE`
`static String`	`LAYOUTS_PREFIX`
`static Logger`	`logger`
`static MenuElement`	`NOT_FOUND_PAGE`
`static String`	`NULL_STRING`
`static String`	`PAGE_TYPE_DEFAULT`
`protected boolean`	`releaseCache`
`static int`	`SEO_HEIGHT_HIGHT`
`static int`	`SEO_HEIGHT_INHERITED`
`static int`	`SEO_HEIGHT_LOW`
`static int`	`SEO_HEIGHT_NORMAL`
`static int`	`SEO_HEIGHT_NULL`
`static double`	`VOTES_MULTIPLY`

Constructor Summary

Constructors
Modifier Constructor Description

protected MenuElement()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MenuElement[]`	`_getAllChildren()`
`String`	`_getPath()`	return the page of this page
`void`	`addAccess(ContentContext ctx)`
`void`	`addChildMenuElement(MenuElement menuElement)`
`void`	`addChildMenuElementAutoPriority(MenuElement menuElement)`
`void`	`addChildMenuElementOnBottom(MenuElement menuElement)`
`void`	`addChildMenuElementOnTop(MenuElement menuElement)`
`void`	`addCompToDelete(String id)`
`void`	`addContent(String parentId, ComponentBean bean)`
`void`	`addContent(String parentId, ComponentBean bean, boolean realeaseCache)`
`void`	`addEditorRole(String group)`
`void`	`addEditorRoles(Collection<String> groups)`
`void`	`addFollowers(ContentContext ctx, String userName)`
`void`	`addVirtualParent(String menuId)`
`void`	`clearEditorGroups()`
`void`	`clearPageBean(ContentContext ctx)`
`void`	`clearVirtualParent()`
`void`	`copyChildren(MenuElement page)`
`int`	`countComponentInCtx(ContentContext ctx, String inComponentType)`	count the component of a specific type on the current page.
`boolean`	`deleteCompList(ContentContext ctx)`
`void`	`deleteComponent(String lang)`	delete components
`void`	`endRendering(ContentContext ctx)`
`boolean`	`equals(Object obj)`
`boolean`	`equals(ContentContext ctx, MenuElement page)`
`boolean`	`equals(ContentContext ctx, MenuElement page, boolean withChildren)`
`protected void`	`finalize()`
`int`	`getAccess(ContentContext ctx, Date date)`
`List<MenuElement>`	`getAllChildrenList()`
`List<MenuElement>`	`getAllChildrenWithComponentType(ContentContext ctx, String type)`
`ContentElementList`	`getAllContent(ContentContext ctx)`
`List<IContentVisualComponent>`	`getAllLanguageContent(ContentContext ctx)`
`ComponentBean[]`	`getAllLocalContentBean()`
`Collection<Resource>`	`getAllResources(ContentContext ctx)`
`List<String>`	`getAllVirtualPath()`	return the page of this page
`String`	`getAreaClass(ContentContext ctx, String area)`
`ExtendedColor`	`getBackgroundColor(ContentContext ctx)`	get the background color
`ContentElementList`	`getBestLanguageContent(ContentContext ctx)`	get the content in current language and in default languages order if not exist.
`String`	`getBlocker()`
`protected ICache`	`getCache(ContentContext ctx)`
`protected String`	`getCacheKey(ContentContext ctx, String subkey)`
`String`	`getCategory(ContentContext ctx)`	get the category of the page (category component)
`String[]`	`getChildList()`
`List<MenuElement>`	`getChildMenuElements()`	get the child list of the current element.
`List<MenuElement>`	`getChildMenuElements(ContentContext ctx, boolean visible)`
`List<MenuElement>`	`getChildMenuElementsList()`	get the child list of the current element.
`List<MenuElement>`	`getChildMenuElementsList(ContentContext ctx, boolean visible)`
`List<MenuElement>`	`getChildMenuElementsWithVirtual(ContentContext ctx, boolean onlyVisible, boolean virtualBefore)`
`List<MenuElement>`	`getChildMenuElementsWithVirtualList(ContentContext ctx, boolean visible, boolean virtualBefore)`
`int`	`getChildPosition(MenuElement child)`
`MenuElement`	`getChildrenAssociationPage()`	get the children association page of the current page.
`List<String>`	`getChildrenCategories(ContentContext ctx)`
`ExtendedColor`	`getColor(ContentContext ctx)`	get the color of the page
`IContentVisualComponent`	`getComponent(ContentContext ctx, String id)`
`Map<String,List<String>>`	`getComponentTypes(ContentContext ctx)`	get list of component type by area
`ContactBean`	`getContact(ContentContext ctx)`	get local i18n data
`ComponentBean[]`	`getContent()`
`ContentElementList`	`getContent(ContentContext ctx)`	get content of the current area
`List<ComponentBean>`	`getContentAsList()`
`Map<String,Object>`	`getContentAsMap(ContentContext ctx)`
`String`	`getContentAsText(ContentContext ctx)`
`Map<Date,List<IContentVisualComponent>>`	`getContentByDate(ContentContext ctx)`	return the content separed on the date component.
`List<IContentVisualComponent>`	`getContentByImplementation(ContentContext ctx, Class clazz)`
`List<IContentVisualComponent>`	`getContentByType(ContentContext ctx, String type)`
`ContentContext`	`getContentContextWithContent(ContentContext ctx)`	return a language with content.
`Date`	`getContentDate(ContentContext ctx)`	get the date found in the content.
`Date`	`getContentDateComponent(ContentContext ctx)`
`Date`	`getContentDateNeverNull(ContentContext ctx)`	return content Date and modification data if no content date.
`Map<String,ContentElementList>`	`getContentElementListMap()`
`String`	`getContentLanguage()`	the content of this page is only for this language (use for import data only)
`String`	`getContentTitle(ContentContext ctx)`	get the real content title.
`Date`	`getCreationDate()`
`String`	`getCreator()`
`String`	`getCss(ContentContext ctx)`
`int`	`getDepth()`	return the depth of the current element
`HtmlPart`	`getDescription(ContentContext ctx)`	get description of the page (description component)
`String`	`getDescriptionAsText(ContentContext ctx)`	get description of the page (description component)
`Set<String>`	`getEditorRoles()`
`Set<String>`	`getEditorRolesAndParent()`
`Date`	`getEndPublishDate()`
`Event`	`getEvent(ContentContext ctx)`	get event if menu element contains event info.
`List<Event>`	`getEvents(ContentContext ctx)`	get event if menu element contains event info.
`Collection<String>`	`getExternalModules(ContentContext ctx)`
`Collection<String>`	`getExternalResources(ContentContext ctx)`
`String`	`getFieldValue(ContentContext ctx, String componentType, String fieldName, String defaultValue)`	return the field value of the first component match with the component type
`Set<String>`	`getFieldValues(ContentContext ctx, String componentType, String fieldName)`	return the field values of all components match with the component type
`int`	`getFinalSeoWeight()`
`MenuElement`	`getFirstChild()`
`List<String>`	`getFollowers(ContentContext ctx)`
`String`	`getFont(ContentContext ctx)`	get the font of the page (category component)
`String`	`getForcedPageTitle(ContentContext ctx)`	get the title of the page define in the content, empty string if no title defined.
`String`	`getForward(ContentContext ctx)`	get the category of the page (category component)
`String`	`getFullLabel(ContentContext ctx)`
`String`	`getFullName()`
`String`	`getGlobalTitle(ContentContext ctx)`
`List<String>`	`getGroupID(ContentContext ctx)`
`String`	`getHeaderContent(ContentContext ctx)`
`String`	`getHTMLChildList(String startTag, String endTag)`	generate a list of navigation element. replace #id with the page id.
`String`	`getHtmlId(ContentContext ctx)`
`String`	`getHtmlSectionId(ContentContext ctx)`
`String`	`getHumanName()`	return the name, as create by user.
`Map<String,String>`	`getI18n(ContentContext ctx)`	get local i18n data
`String`	`getId()`
`IImageTitle`	`getImage(ContentContext ctx)`
`IImageTitle`	`getImageBackground(ContentContext ctx)`
`Map<String,ImageTitleBean>`	`getImageBackgroundForArea(ContentContext ctx)`
`ImageBean`	`getImageBean(ContentContext ctx)`
`List<IImageTitle>`	`getImages(ContentContext ctx)`
`int`	`getIndex()`	get index of the page in the children list of the her parent page
`static MenuElement`	`getInstance(ContentContext ctx)`
`String`	`getIpSecurityErrorPageName()`
`String`	`getKeywords(ContentContext ctx)`
`String`	`getLabel(ContentContext ctx)`
`int`	`getLastAccess(ContentContext ctx)`
`String`	`getLatestEditor()`
`List<String>`	`getLayouts(ContentContext ctx)`
`String`	`getLinkedURL()`
`String`	`getLinkLabel(ContentContext ctx)`	label of the link to page.
`String`	`getLinkOn(ContentContext ctx)`	get the first link on the page.
`ContentElementList`	`getLocalContentCopy(ContentContext ctx)`
`List<String>`	`getLocalFollowers(ContentContext ctx)`
`String`	`getLocalTitle(ContentContext ctx)`	get title withtout repeat content
`String`	`getLocation(ContentContext ctx)`	get description of the page (description component)
`MenuElement`	`getMainChildrenAssociation()`	get the page marked as children association
`String`	`getMainContentLabel(ContentContext ctx)`
`Date`	`getManualModificationDate()`
`String`	`getMetaDescription(ContentContext ctx)`	get the description for meta tag (if no meta description defined return the description)
`String`	`getMetaHead(ContentContext ctx)`	get the metaHead for meta tag (if no meta description defined return the description)
`Date`	`getModificationDate()`
`Date`	`getModificationDate(ContentContext ctx)`
`String`	`getName()`	reutrn the name, formated as "file name", without space and special char.
`MenuElement`	`getNextBrother()`	get the next menu element in the child list
`MenuElement`	`getNoErrorFreeCurrentPage(ContentContext ctx)`
`List<IContentVisualComponent>`	`getNoRepeatContentByType(ContentContext ctx, String type)`
`IContentVisualComponent`	`getNotCacheableComponent(ContentContext ctx)`
`PageBean`	`getPageBean(ContentContext ctx)`
`protected MenuElement`	`getPageCached(String key)`
`protected PageDescription`	`getPageDescription(ContentContext ctx)`
`double`	`getPageRank(ContentContext ctx)`	get the page rank (define with content)
`String`	`getPageTitle(ContentContext ctx)`
`MenuElement`	`getParent()`
`String`	`getPath()`	return the page of this page
`String`	`getPDFLayout(ContentContext ctx)`
`int`	`getPosition()`	return the position on the page in the children list of her parent
`MenuElement`	`getPreviousBrother()`	get the previous menu element in the child list
`int`	`getPriority()`
`Product.ProductBean`	`getProduct(ContentContext ctx)`
`int`	`getReactionSize(ContentContext ctx)`	get number of reactions of the page (description component)
`IContentVisualComponent`	`getRealContentComponent(ContentContext ctx)`
`String`	`getRealContentLanguage(ContentContext ctx)`
`Date`	`getRealModificationDate(ContentContext ctx)`
`String`	`getReferenceLanguage()`
`Map<String,String>`	`getReplacement()`
`Map<String,String>`	`getReplacementEditable()`
`String`	`getReversedLink()`
`MenuElement`	`getRoot()`
`MenuElement`	`getRootOfChildrenAssociation()`	get the root (parent) of the children association page
`String`	`getSavedParent()`
`int`	`getSelectedDepth(ContentContext ctx)`	return the depth of the selection. sample: if the first selected element have children and sedond not the depth is 2.
`int`	`getSeoWeight()`
`String`	`getSharedName()`
`String`	`getShortLanguageURL(ContentContext ctx)`
`String`	`getShortURL()`
`String`	`getShortURL(ContentContext ctx)`
`String`	`getShortURL(ContentContext ctx, boolean releaseCache)`
`double`	`getSiteMapPriority(ContentContext ctx)`
`String`	`getSlogan(ContentContext ctx)`	get the slogan of the page (slogan component)
`PageDescription`	`getSmartPageDescription(ContentContext ctx)`
`Date`	`getStartPublishDate()`
`Collection<Link>`	`getStaticResources(ContentContext ctx)`
`String`	`getSubTitle(ContentContext ctx)`
`int`	`getSubTitleLevel(ContentContext ctx)`
`List<String>`	`getSubTitles(ContentContext ctx, int level)`
`List<String>`	`getTags(ContentContext ctx)`
`Set<String>`	`getTaxonomy()`
`String`	`getTechnicalTitle(ContentContext ctx)`	create a title without space and special character with the title of the page in the default language.
`String`	`getTemplateId()`
`String`	`getTemplateIdOnInherited(ContentContext ctx)`
`Collection<MenuElement>`	`getTemplates()`
`TimeRange`	`getTimeRange(ContentContext ctx)`	get the time range found in the content.
`String`	`getTitle(ContentContext ctx)`
`int`	`getToTheTopLevel(ContentContext ctx)`
`String`	`getType()`
`int`	`getUrlNumber()`	in case of same URL, this value in incremented. all URL factory (implementation of @IURLFactory) can use this number for create different URL.
`Set<String>`	`getUserRoles()`
`String`	`getValidater()`
`Date`	`getValidationDate()`
`List<MenuElement>`	`getVirtualChild(ContentContext ctx, boolean onlyVisible)`
`List<MenuElement>`	`getVirtualParent()`
`String`	`getVirtualPath(ContentContext ctx)`	return the page of this page
`List<MenuElement>`	`getVisibleChildMenuElements(ContentContext ctx)`	get the child list of the current element.
`List<MenuElement>`	`getVisibleChildMenuElementsList(ContentContext ctx)`
`String`	`getXHTMLDescription(ContentContext ctx)`	get description of the page (description component)
`String`	`getXHTMLTitle(ContentContext ctx)`
`boolean`	`isActive()`
`boolean`	`isActive(ContentContext ctx)`
`boolean`	`isAdmin()`
`boolean`	`isBlocked()`
`boolean`	`isBreakRepeat()`
`boolean`	`isCacheable(ContentContext ctx)`	check if the page is cacheable (static content)
`boolean`	`isChildOf(String page)`	check if the current page is a child of a page with id or name give in parameter.
`boolean`	`isChildOf(MenuElement parent)`	check if a page is parent or parent of a parent.
`boolean`	`isChildrenAssociation()`
`boolean`	`isChildrenEquals(MenuElement elem)`
`boolean`	`isChildrenOfAssociation()`	check if this page is a part of page association
`boolean`	`isContentDateVisible(ContentContext ctx)`
`boolean`	`isContentEquals(MenuElement elem)`
`boolean`	`isDirectChildrenOfAssociation()`	check if this page is a direct children of page association
`boolean`	`isEditabled(ContentContext ctx)`
`boolean`	`isEditAccess(ContentContext ctx)`
`boolean`	`isEmpty(ContentContext ctx)`
`boolean`	`isEmpty(ContentContext ctx, String area)`
`boolean`	`isEmpty(ContentContext ctx, String area, boolean withRepeat)`
`boolean`	`isHaveChild()`
`boolean`	`isHaveVisibleChild(ContentContext ctx)`
`boolean`	`isHttps()`
`boolean`	`isInTrash()`
`boolean`	`isLastSelected(ContentContext ctx)`
`boolean`	`isLayout()`
`boolean`	`isLikeRoot(ContentContext ctx)`
`boolean`	`isLinkRealContent(ContentContext ctx)`
`boolean`	`isLocalEmpty(ContentContext ctx, String area)`
`boolean`	`isMetadataEquals(MenuElement elem)`
`boolean`	`isModel()`
`boolean`	`isNeedValidation()`
`boolean`	`isNoComponent(ContentContext ctx)`
`boolean`	`isNoComponent(ContentContext ctx, String area)`
`boolean`	`isNoIndex()`
`boolean`	`isNoValidation()`
`boolean`	`isPageActive()`
`boolean`	`isPublic(ContentContext ctx)`
`boolean`	`isReadAccess(ContentContext ctx, User user)`
`boolean`	`isRealContent(ContentContext ctx)`
`boolean`	`isRealContentAnyLanguage(ContentContext ctx)`
`boolean`	`isRealContentAuto(ContentContext ctx)`
`boolean`	`isReference(ContentContext ctx)`	is a page with reference to other page, like page reference of children link
`boolean`	`isRemote()`
`boolean`	`isRestWidthChildren()`
`boolean`	`isRoot()`
`boolean`	`isRootChildrenAssociation()`
`boolean`	`isSelected(ContentContext ctx)`
`boolean`	`isShortURL()`
`boolean`	`isTimeRange()`	return true if time range can modify the status of the page in the future.
`boolean`	`isTitle(ContentContext ctx)`
`boolean`	`isTrash()`
`boolean`	`isValid()`
`boolean`	`isVisible()`
`boolean`	`isVisible(ContentContext ctx)`
`void`	`moveToParent(MenuElement parent)`	move the current page under other parent
`boolean`	`needTemplate(ContentContext ctx, String templateId)`	check if page need a specific template.
`boolean`	`notInSearch(ContentContext ctx)`
`String`	`prepareAddContent(String lg, String parentCompId, String contentType, String style, String value, User authors)`	prepare a content to be added at the end of the rendering
`void`	`printInfo(ContentContext ctx, PrintStream out)`
`void`	`releaseCache()`
`void`	`removeChild(MenuElement elem)`
`String`	`removeContent(ContentContext ctx, String id)`	remove a component on the page
`String`	`removeContent(ContentContext ctx, String id, boolean releaseCache)`	remove a component on the page
`void`	`removeEditorRoles(String group)`
`void`	`removeFollowers(ContentContext ctx, String userName)`
`MenuElement`	`searchChild(ContentContext ctx)`
`MenuElement`	`searchChild(ContentContext ctx, String path)`
`static MenuElement`	`searchChild(MenuElement elem, ContentContext ctx, String path, Collection<MenuElement> pastNode)`
`MenuElement`	`searchChildFromId(String id)`
`MenuElement`	`searchChildFromName(String... names)`
`MenuElement`	`searchRealChild(ContentContext ctx, String path)`
`void`	`setActive(boolean active)`
`void`	`setAdmin(boolean admin)`
`void`	`setBlocked(boolean blocked)`
`void`	`setBlocker(String blocker)`
`void`	`setBreakRepeat(boolean breakRepeat)`
`void`	`setChildrenAssociation(boolean childrenAssociation)`
`void`	`setContent(ComponentBean[] newContent)`
`void`	`setContentLanguage(String contentLanguage)`
`void`	`setContentStayCache(ComponentBean[] newContent)`
`void`	`setCreationDate(Date createDate)`
`void`	`setCreator(String creator)`
`void`	`setEditRoles(MenuElement page)`
`void`	`setEndPublishDate(Date endPublishDate)`
`void`	`setHttps(boolean https)`
`void`	`setId(String string)`
`void`	`setIpSecurityErrorPageName(String ipSecurity)`
`void`	`setLatestEditor(String latestEditor)`
`void`	`setLinkedURL(String linkedURL)`
`void`	`setManualModificationDate(Date manualModificationDate)`
`void`	`setModel(boolean model)`
`void`	`setModificationDate(Date modificationDate)`
`void`	`setName(String name)`
`void`	`setNeedValidation(boolean needValidation)`
`void`	`setNoValidation(boolean noValidation)`
`protected void`	`setPageCached(String key, MenuElement page)`
`void`	`setParent(MenuElement parent)`
`void`	`setPriority(int newPriority)`
`void`	`setPriorityNoSort(int newPriority)`
`void`	`setReferenceLanguage(String referenceLanguage)`
`void`	`setRemote(boolean readOnly)`
`void`	`setRestWidthChildren(boolean restWidthChildren)`
`void`	`setReversedLink(String reversedLink)`
`void`	`setSavedParent(String freeData)`
`void`	`setSeoWeight(int searchEngineWeight)`
`void`	`setSharedName(String sharedName)`
`void`	`setShortURL(String shortURL)`
`void`	`setStartPublishDate(Date startPublishDate)`
`void`	`setTaxonomy(Set<String> taxonomy)`
`void`	`setTemplateId(String inTemplate)`
`void`	`setType(String type)`
`void`	`setUrlNumber(int urlNumber)`
`void`	`setUserRoles(Set<String> roles)`
`void`	`setValid(boolean valid)`
`void`	`setValidater(String validater)`
`void`	`setValidationDate(Date validationDate)`
`void`	`setVirtualParent(List<MenuElement> newVirtualParent)`
`void`	`setVisible(boolean b)`
`String`	`toString()`
`void`	`updateLinkedData(ContentContext ctx)`

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NOT_FOUND_PAGE

public static MenuElement NOT_FOUND_PAGE

NULL_STRING
```
public static final String NULL_STRING
```
See Also:

Constant Field Values

INSTANCE
```
public static int INSTANCE
```

PAGE_TYPE_DEFAULT

public static final String PAGE_TYPE_DEFAULT

See Also:: Constant Field Values

VOTES_MULTIPLY
```
public static final double VOTES_MULTIPLY
```
See Also:

Constant Field Values

SEO_HEIGHT_INHERITED
```
public static final int SEO_HEIGHT_INHERITED
```
See Also:

Constant Field Values

SEO_HEIGHT_NULL
```
public static final int SEO_HEIGHT_NULL
```
See Also:

Constant Field Values

SEO_HEIGHT_LOW
```
public static final int SEO_HEIGHT_LOW
```
See Also:

Constant Field Values

SEO_HEIGHT_NORMAL
```
public static final int SEO_HEIGHT_NORMAL
```
See Also:

Constant Field Values

SEO_HEIGHT_HIGHT
```
public static final int SEO_HEIGHT_HIGHT
```
See Also:

Constant Field Values

LAYOUTS_PREFIX

public static final String LAYOUTS_PREFIX

See Also:: Constant Field Values

releaseCache
```
protected boolean releaseCache
```

logger
```
public static Logger logger
```

Constructor Detail
- MenuElement
```
protected MenuElement()
```

Method Detail

getPageDescription

protected PageDescription getPageDescription(ContentContext ctx)
                                      throws Exception

Throws:: Exception

getMainContentLabel

public String getMainContentLabel(ContentContext ctx)

isActive

public boolean isActive(ContentContext ctx)

getSmartPageDescription

public PageDescription getSmartPageDescription(ContentContext ctx)

getInstance

public static MenuElement getInstance(ContentContext ctx)

searchChild

public static MenuElement searchChild(MenuElement elem,
                                      ContentContext ctx,
                                      String path,
                                      Collection<MenuElement> pastNode)
                               throws Exception

Throws:: Exception

getPageCached

protected MenuElement getPageCached(String key)

setPageCached

protected void setPageCached(String key,
                             MenuElement page)

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

addAccess

public void addAccess(ContentContext ctx)

addChildMenuElement

public void addChildMenuElement(MenuElement menuElement)

addChildMenuElementAutoPriority

public void addChildMenuElementAutoPriority(MenuElement menuElement)

addChildMenuElementOnTop

public void addChildMenuElementOnTop(MenuElement menuElement)

addChildMenuElementOnBottom

public void addChildMenuElementOnBottom(MenuElement menuElement)

addCompToDelete

public void addCompToDelete(String id)

addContent

public void addContent(String parentId,
                       ComponentBean bean)

addContent

public void addContent(String parentId,
                       ComponentBean bean,
                       boolean realeaseCache)

addEditorRole

public void addEditorRole(String group)

addEditorRoles

public void addEditorRoles(Collection<String> groups)

addVirtualParent

public void addVirtualParent(String menuId)

clearEditorGroups
```
public void clearEditorGroups()
```

getContentElementListMap

public Map<String,ContentElementList> getContentElementListMap()

clearVirtualParent
```
public void clearVirtualParent()
```

countComponentInCtx
```
public int countComponentInCtx(ContentContext ctx,
                               String inComponentType)
                        throws Exception
```
count the component of a specific type on the current page.

Parameters:

ctx - the current context.

inComponentType - the type of the component

Returns:

a count of component.

Throws:

Exception

deleteCompList

public boolean deleteCompList(ContentContext ctx)

endRendering

public void endRendering(ContentContext ctx)

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getAccess

public int getAccess(ContentContext ctx,
                     Date date)

_getAllChildren

public MenuElement[] _getAllChildren()
                              throws Exception

Throws:: Exception

getAllChildrenList

public List<MenuElement> getAllChildrenList()
                                     throws Exception

Throws:: Exception

getAllChildrenWithComponentType

public List<MenuElement> getAllChildrenWithComponentType(ContentContext ctx,
                                                         String type)
                                                  throws Exception

Throws:: Exception

getAllContent

public ContentElementList getAllContent(ContentContext ctx)
                                 throws Exception

Throws:: Exception

getAllLocalContentBean

public ComponentBean[] getAllLocalContentBean()
                                       throws Exception

Throws:: Exception

getAllResources

public Collection<Resource> getAllResources(ContentContext ctx)
                                     throws Exception

Throws:: Exception

getAllVirtualPath
```
public List<String> getAllVirtualPath()
```
return the page of this page

Returns:

a path.

getBestLanguageContent

public ContentElementList getBestLanguageContent(ContentContext ctx)
                                          throws Exception

get the content in current language and in default languages order if not exist.

Throws:: Exception

getBlocker
```
public String getBlocker()
```

getCacheKey

protected String getCacheKey(ContentContext ctx,
                             String subkey)

getCategory
```
public String getCategory(ContentContext ctx)
                   throws Exception
```
get the category of the page (category component)

Parameters:

ctx -

Returns:

Throws:

Exception

getFont
```
public String getFont(ContentContext ctx)
               throws Exception
```
get the font of the page (category component)

Parameters:

ctx -

Returns:

Throws:

Exception

getForward
```
public String getForward(ContentContext ctx)
                  throws Exception
```
get the category of the page (category component)

Parameters:

ctx -

Returns:

Throws:

Exception

getSlogan
```
public String getSlogan(ContentContext ctx)
                 throws Exception
```
get the slogan of the page (slogan component)

Parameters:

ctx -

Returns:

Throws:

Exception

getColor

public ExtendedColor getColor(ContentContext ctx)
                       throws Exception

get the color of the page

Parameters:: ctx -
Returns:
Throws:: Exception

getBackgroundColor

public ExtendedColor getBackgroundColor(ContentContext ctx)
                                 throws Exception

get the background color

Parameters:: ctx -
Returns:
Throws:: Exception

getChildList

public String[] getChildList()
                      throws Exception

Throws:: Exception

getChildMenuElements
```
public List<MenuElement> getChildMenuElements()
```
get the child list of the current element.

Returns:

a array of children.

getChildPosition

public int getChildPosition(MenuElement child)

getPosition
```
public int getPosition()
```
return the position on the page in the children list of her parent

Returns:

getChildMenuElements

public List<MenuElement> getChildMenuElements(ContentContext ctx,
                                              boolean visible)
                                       throws Exception

Throws:: Exception

getChildMenuElementsList
```
public List<MenuElement> getChildMenuElementsList()
```
get the child list of the current element.

Returns:

a list of children.

getChildMenuElementsList

public List<MenuElement> getChildMenuElementsList(ContentContext ctx,
                                                  boolean visible)
                                           throws Exception

Throws:: Exception

getChildMenuElementsWithVirtual

public List<MenuElement> getChildMenuElementsWithVirtual(ContentContext ctx,
                                                         boolean onlyVisible,
                                                         boolean virtualBefore)
                                                  throws Exception

Throws:: Exception

getChildMenuElementsWithVirtualList

public List<MenuElement> getChildMenuElementsWithVirtualList(ContentContext ctx,
                                                             boolean visible,
                                                             boolean virtualBefore)
                                                      throws Exception

Throws:: Exception

getContent
```
public ComponentBean[] getContent()
```

getContentAsText

public String getContentAsText(ContentContext ctx)
                        throws Exception

Throws:: Exception

getContentAsList

public List<ComponentBean> getContentAsList()

getContent
```
public ContentElementList getContent(ContentContext ctx)
                              throws Exception
```
get content of the current area

Parameters:

ctx - the content context

Returns:

a list of component

Throws:

Exception

getContentByDate

public Map<Date,List<IContentVisualComponent>> getContentByDate(ContentContext ctx)
                                                               throws Exception

return the content separed on the date component.

Parameters:: ctx -
Returns:
Throws:: Exception

getContentByType

public List<IContentVisualComponent> getContentByType(ContentContext ctx,
                                                      String type)
                                               throws Exception

Throws:: Exception

getAllLanguageContent

public List<IContentVisualComponent> getAllLanguageContent(ContentContext ctx)
                                                    throws Exception

Throws:: Exception

getContentByImplementation

public List<IContentVisualComponent> getContentByImplementation(ContentContext ctx,
                                                                Class clazz)
                                                         throws Exception

Throws:: Exception

getContentContextWithContent
```
public ContentContext getContentContextWithContent(ContentContext ctx)
                                            throws Exception
```
return a language with content. If there are content in current language, it is returned.

Returns:

a ContentContext with content or current context if there are no content in any language.

Throws:

Exception

getContentDate

public Date getContentDate(ContentContext ctx)
                    throws Exception

get the date found in the content.

Returns:
Throws:: Exception

getToTheTopLevel

public int getToTheTopLevel(ContentContext ctx)
                     throws Exception

Throws:: Exception

getContentDateComponent

public Date getContentDateComponent(ContentContext ctx)
                             throws Exception

Throws:: Exception

getContentDateNeverNull
```
public Date getContentDateNeverNull(ContentContext ctx)
                             throws Exception
```
return content Date and modification data if no content date.

Parameters:

ctx -

Returns:

Throws:

Exception

getCreationDate
```
public Date getCreationDate()
```

getCreator
```
public String getCreator()
```

getDepth
```
public int getDepth()
```
return the depth of the current element

Returns:

a depth

getDescription

public HtmlPart getDescription(ContentContext ctx)
                        throws Exception

get description of the page (description component)

Parameters:: ctx -
Returns:
Throws:: Exception

getDescriptionAsText

public String getDescriptionAsText(ContentContext ctx)
                            throws Exception

get description of the page (description component)

Parameters:: ctx -
Returns:
Throws:: Exception

getXHTMLDescription

public String getXHTMLDescription(ContentContext ctx)
                           throws Exception

get description of the page (description component)

Parameters:: ctx -
Returns:
Throws:: Exception

getReactionSize
```
public int getReactionSize(ContentContext ctx)
                    throws Exception
```
get number of reactions of the page (description component)

Parameters:

ctx -

Returns:

Throws:

Exception

getEditorRoles
```
public Set<String> getEditorRoles()
```

setEditRoles

public void setEditRoles(MenuElement page)

getEditorRolesAndParent

public Set<String> getEditorRolesAndParent()

getFollowers

public List<String> getFollowers(ContentContext ctx)

addFollowers

public void addFollowers(ContentContext ctx,
                         String userName)

getLocalFollowers

public List<String> getLocalFollowers(ContentContext ctx)

removeFollowers

public void removeFollowers(ContentContext ctx,
                            String userName)

getExternalResources

public Collection<String> getExternalResources(ContentContext ctx)
                                        throws Exception

Throws:: Exception

getExternalModules

public Collection<String> getExternalModules(ContentContext ctx)
                                      throws Exception

Throws:: Exception

getFieldValue

public String getFieldValue(ContentContext ctx,
                            String componentType,
                            String fieldName,
                            String defaultValue)
                     throws Exception

return the field value of the first component match with the component type

Parameters:: ctx -; componentType -; fieldName -; defaultValue - value if component or field not found
Returns:
Throws:: Exception

getFieldValues

public Set<String> getFieldValues(ContentContext ctx,
                                  String componentType,
                                  String fieldName)
                           throws Exception

return the field values of all components match with the component type

Parameters:: ctx -; componentType -; fieldName -; defaultValue - value if component or field not found
Returns:: a set of values, empty set if not found.
Throws:: Exception

getFullLabel

public String getFullLabel(ContentContext ctx)
                    throws Exception

Throws:: Exception

getFullName
```
public String getFullName()
```

getGlobalTitle

public String getGlobalTitle(ContentContext ctx)
                      throws Exception

Throws:: Exception

getGroupID

public List<String> getGroupID(ContentContext ctx)
                        throws Exception

Throws:: Exception

getChildrenCategories

public List<String> getChildrenCategories(ContentContext ctx)
                                   throws Exception

Throws:: Exception

getHeaderContent

public String getHeaderContent(ContentContext ctx)
                        throws Exception

Throws:: Exception

getHTMLChildList
```
public String getHTMLChildList(String startTag,
                               String endTag)
                        throws Exception
```
generate a list of navigation element. replace #id with the page id.

Parameters:

startTag - insert before path sample :

endTag - insert after path :

Returns:

a string with XHTML code

Throws:

Exception

getId
```
public String getId()
```
Returns:

getImageBackground

public IImageTitle getImageBackground(ContentContext ctx)
                               throws Exception

Throws:: Exception

getImageBackgroundForArea

public Map<String,ImageTitleBean> getImageBackgroundForArea(ContentContext ctx)
                                                           throws Exception

Throws:: Exception

getImageBean

public ImageBean getImageBean(ContentContext ctx)
                       throws Exception

Throws:: Exception

getImage

public IImageTitle getImage(ContentContext ctx)
                     throws Exception

Throws:: Exception

getImages

public List<IImageTitle> getImages(ContentContext ctx)
                            throws Exception

Throws:: Exception

getStaticResources

public Collection<Link> getStaticResources(ContentContext ctx)
                                    throws Exception

Throws:: Exception

getKeywords

public String getKeywords(ContentContext ctx)
                   throws Exception

Throws:: Exception

getLabel

public String getLabel(ContentContext ctx)
                throws Exception

Throws:: Exception

getLastAccess

public int getLastAccess(ContentContext ctx)
                  throws ServiceException

Throws:: ServiceException

getLatestEditor
```
public String getLatestEditor()
```

getLinkedURL
```
public String getLinkedURL()
```

getLinkOn

public String getLinkOn(ContentContext ctx)
                 throws Exception

get the first link on the page.

Parameters:: ctx -
Returns:
Throws:: Exception

isLinkRealContent

public boolean isLinkRealContent(ContentContext ctx)
                          throws Exception

Throws:: Exception

getLocalContentCopy

public ContentElementList getLocalContentCopy(ContentContext ctx)
                                       throws Exception

Throws:: Exception

getLocation
```
public String getLocation(ContentContext ctx)
                   throws Exception
```
get description of the page (description component)

Parameters:

ctx -

Returns:

Throws:

Exception

getManualModificationDate

public Date getManualModificationDate()

getMetaHead
```
public String getMetaHead(ContentContext ctx)
                   throws Exception
```
get the metaHead for meta tag (if no meta description defined return the description)

Parameters:

ctx -

Returns:

Throws:

Exception

getMetaDescription
```
public String getMetaDescription(ContentContext ctx)
                          throws Exception
```
get the description for meta tag (if no meta description defined return the description)

Parameters:

ctx -

Returns:

Throws:

Exception

getModificationDate

public Date getModificationDate()
                         throws ParseException,
                                Exception

Throws:: ParseException; Exception

getModificationDate

public Date getModificationDate(ContentContext ctx)
                         throws ParseException,
                                Exception

Throws:: ParseException; Exception

getName
```
public String getName()
```
reutrn the name, formated as "file name", without space and special char.

Returns:

getHumanName
```
public String getHumanName()
```
return the name, as create by user.

Returns:

getNextBrother
```
public MenuElement getNextBrother()
```
get the next menu element in the child list

Returns:

a MenuElement with the same depth, null if current is the first element.

getNoErrorFreeCurrentPage

public MenuElement getNoErrorFreeCurrentPage(ContentContext ctx)
                                      throws Exception

Throws:: Exception

getNoRepeatContentByType

public List<IContentVisualComponent> getNoRepeatContentByType(ContentContext ctx,
                                                              String type)
                                                       throws Exception

Throws:: Exception

getCache

protected ICache getCache(ContentContext ctx)

clearPageBean

public void clearPageBean(ContentContext ctx)

getPageBean

public PageBean getPageBean(ContentContext ctx)
                     throws Exception

Throws:: Exception

getIndex
```
public int getIndex()
```
get index of the page in the children list of the her parent page

Returns:

getPageRank
```
public double getPageRank(ContentContext ctx)
                   throws Exception
```
get the page rank (define with content)

Returns:

a page rank between 0 and 1

Throws:

Exception

getForcedPageTitle
```
public String getForcedPageTitle(ContentContext ctx)
                          throws Exception
```
get the title of the page define in the content, empty string if no title defined.

Parameters:

ctx -

Returns:

Throws:

Exception

getPageTitle

public String getPageTitle(ContentContext ctx)
                    throws Exception

Throws:: Exception

getParent
```
public MenuElement getParent()
```
Returns:

Returns the parent.

isRoot
```
public boolean isRoot()
```

isLikeRoot

public boolean isLikeRoot(ContentContext ctx)
                   throws Exception

Throws:: Exception

isChildOf
```
public boolean isChildOf(String page)
```
check if the current page is a child of a page with id or name give in parameter.

Parameters:

page - name, id of a page or path of the page.

Returns:

_getPath
```
public String _getPath()
```
return the page of this page

Returns:

a path.

getPath
```
public String getPath()
```
return the page of this page

Returns:

a path.

getPreviousBrother
```
public MenuElement getPreviousBrother()
```
get the previous menu element in the child list

Returns:

a MenuElement with the same depth, null if current is the first element.

getPriority
```
public int getPriority()
```

getRealModificationDate

public Date getRealModificationDate(ContentContext ctx)
                             throws ParseException,
                                    Exception

Throws:: ParseException; Exception

getReplacement

public Map<String,String> getReplacement()

getReplacementEditable

public Map<String,String> getReplacementEditable()

getReversedLink
```
public String getReversedLink()
```

getRoot
```
public MenuElement getRoot()
```

getSelectedDepth
```
public int getSelectedDepth(ContentContext ctx)
                     throws Exception
```
return the depth of the selection. sample: if the first selected element have children and sedond not the depth is 2.

Returns:

a depth

Throws:

Exception

getSiteMapPriority

public double getSiteMapPriority(ContentContext ctx)

getSubTitle

public String getSubTitle(ContentContext ctx)
                   throws Exception

Throws:: Exception

getSubTitles

public List<String> getSubTitles(ContentContext ctx,
                                 int level)
                          throws Exception

Throws:: Exception

getLinkLabel

public String getLinkLabel(ContentContext ctx)
                    throws Exception

label of the link to page.

Parameters:: ctx -
Returns:
Throws:: Exception

getSubTitleLevel

public int getSubTitleLevel(ContentContext ctx)
                     throws Exception

Throws:: Exception

getTags

public List<String> getTags(ContentContext ctx)
                     throws Exception

Throws:: Exception

getLayouts

public List<String> getLayouts(ContentContext ctx)
                        throws Exception

Throws:: Exception

getProduct

public Product.ProductBean getProduct(ContentContext ctx)
                               throws Exception

Throws:: Exception

getTemplateId
```
public String getTemplateId()
```

getTemplateIdOnInherited

public String getTemplateIdOnInherited(ContentContext ctx)

getTemplates

public Collection<MenuElement> getTemplates()

getTimeRange

public TimeRange getTimeRange(ContentContext ctx)
                       throws Exception

get the time range found in the content.

Returns:
Throws:: Exception

getContentTitle
```
public String getContentTitle(ContentContext ctx)
                       throws Exception
```
get the real content title.

Parameters:

ctx -

Returns:

null if no title found in content.

Throws:

Exception

isTitle

public boolean isTitle(ContentContext ctx)
                throws Exception

Throws:: Exception

getTitle

public String getTitle(ContentContext ctx)
                throws Exception

Throws:: Exception

getTechnicalTitle
```
public String getTechnicalTitle(ContentContext ctx)
```
create a title without space and special character with the title of the page in the default language.

Parameters:

ctx -

Returns:

getLocalTitle

public String getLocalTitle(ContentContext ctx)
                     throws Exception

get title withtout repeat content

Parameters:: ctx -
Returns:
Throws:: Exception

getUserRoles
```
public Set<String> getUserRoles()
```
Returns:

isReadAccess

public boolean isReadAccess(ContentContext ctx,
                            User user)

isEditAccess

public boolean isEditAccess(ContentContext ctx)
                     throws Exception

Throws:: Exception

getValidater
```
public String getValidater()
```

getValidationDate
```
public Date getValidationDate()
```

getVirtualChild

public List<MenuElement> getVirtualChild(ContentContext ctx,
                                         boolean onlyVisible)
                                  throws Exception

Throws:: Exception

getVirtualParent

public List<MenuElement> getVirtualParent()

getVirtualPath

public String getVirtualPath(ContentContext ctx)

return the page of this page

Returns:: a path.

getVisibleChildMenuElements

public List<MenuElement> getVisibleChildMenuElements(ContentContext ctx)
                                              throws Exception

get the child list of the current element.

Returns:: a array of children.
Throws:: Exception

getVisibleChildMenuElementsList

public List<MenuElement> getVisibleChildMenuElementsList(ContentContext ctx)
                                                  throws Exception

Throws:: Exception

getXHTMLTitle

public String getXHTMLTitle(ContentContext ctx)
                     throws Exception

Throws:: Exception

isBlocked
```
public boolean isBlocked()
```

isChildOf
```
public boolean isChildOf(MenuElement parent)
```
check if a page is parent or parent of a parent.

Parameters:

parent - a page of the navigation.

Returns:

true if page found in paternity

isChildrenEquals

public boolean isChildrenEquals(MenuElement elem)

isContentDateVisible

public boolean isContentDateVisible(ContentContext ctx)
                             throws Exception

Throws:: Exception

isContentEquals

public boolean isContentEquals(MenuElement elem)

isEmpty

public boolean isEmpty(ContentContext ctx)
                throws Exception

Throws:: Exception

isNoComponent

public boolean isNoComponent(ContentContext ctx)
                      throws Exception

Throws:: Exception

isNoComponent

public boolean isNoComponent(ContentContext ctx,
                             String area)
                      throws Exception

Throws:: Exception

isEmpty

public boolean isEmpty(ContentContext ctx,
                       String area)
                throws Exception

Throws:: Exception

isLocalEmpty

public boolean isLocalEmpty(ContentContext ctx,
                            String area)
                     throws Exception

Throws:: Exception

isEmpty

public boolean isEmpty(ContentContext ctx,
                       String area,
                       boolean withRepeat)
                throws Exception

Throws:: Exception

isHaveChild
```
public boolean isHaveChild()
```
Returns:

isHaveVisibleChild

public boolean isHaveVisibleChild(ContentContext ctx)
                           throws Exception

Throws:: Exception

isHttps
```
public boolean isHttps()
```

isLastSelected

public boolean isLastSelected(ContentContext ctx)

isMetadataEquals

public boolean isMetadataEquals(MenuElement elem)

isRealContentAuto

public boolean isRealContentAuto(ContentContext ctx)
                          throws Exception

Throws:: Exception

isRealContent

public boolean isRealContent(ContentContext ctx)
                      throws Exception

Throws:: Exception

isRealContentAnyLanguage

public boolean isRealContentAnyLanguage(ContentContext ctx)
                                 throws Exception

Throws:: Exception

getRealContentLanguage

public String getRealContentLanguage(ContentContext ctx)
                              throws Exception

Throws:: Exception

isRemote
```
public boolean isRemote()
```

isSelected

public boolean isSelected(ContentContext ctx)
                   throws Exception

Throws:: Exception

isValid
```
public boolean isValid()
```

isVisible

public boolean isVisible()
                  throws Exception

Throws:: Exception

isActive
```
public boolean isActive()
```

isPageActive
```
public boolean isPageActive()
```

setActive

public void setActive(boolean active)

isVisible

public boolean isVisible(ContentContext ctx)
                  throws Exception

Returns:
Throws:: Exception

moveToParent

public void moveToParent(MenuElement parent)

move the current page under other parent

prepareAddContent

public final String prepareAddContent(String lg,
                                      String parentCompId,
                                      String contentType,
                                      String style,
                                      String value,
                                      User authors)
                               throws Exception

prepare a content to be added at the end of the rendering

Parameters:: ctx - the current content context; page - the page when the content must be insered; parentComp - the parent component; contentType - the type of the component; value - the value of the component
Returns:: the if of the new component
Throws:: Exception

releaseCache
```
public void releaseCache()
```

removeChild

public void removeChild(MenuElement elem)

removeContent

public String removeContent(ContentContext ctx,
                            String id)

remove a component on the page

Returns:: the type of the component, null if not found

removeContent
```
public String removeContent(ContentContext ctx,
                            String id,
                            boolean releaseCache)
```
remove a component on the page

Parameters:

releaseCache - true if you want release the page cache after deleted component

Returns:

the type of the component, null if not found

removeEditorRoles

public void removeEditorRoles(String group)

searchChild

public MenuElement searchChild(ContentContext ctx)
                        throws Exception

Throws:: Exception

searchChild

public MenuElement searchChild(ContentContext ctx,
                               String path)
                        throws Exception

Throws:: Exception

searchChildFromId

public MenuElement searchChildFromId(String id)

Parameters:: id -
Returns:

searchChildFromName
```
public MenuElement searchChildFromName(String... names)
```
Parameters:

names - list of possible name

Returns:

searchRealChild

public MenuElement searchRealChild(ContentContext ctx,
                                   String path)
                            throws Exception

Throws:: Exception

setBlocked

public void setBlocked(boolean blocked)

setBlocker

public void setBlocker(String blocker)

setContent

public void setContent(ComponentBean[] newContent)

setContentStayCache

public void setContentStayCache(ComponentBean[] newContent)

setCreationDate

public void setCreationDate(Date createDate)

setCreator

public void setCreator(String creator)

setHttps

public void setHttps(boolean https)

setId
```
public void setId(String string)
```
Parameters:

string -

setLatestEditor

public void setLatestEditor(String latestEditor)

setLinkedURL

public void setLinkedURL(String linkedURL)

setManualModificationDate

public void setManualModificationDate(Date manualModificationDate)

setModificationDate

public void setModificationDate(Date modificationDate)

setName
```
public void setName(String name)
```

setParent

public void setParent(MenuElement parent)

Parameters:: parent - The parent to set.

setPriority

public void setPriority(int newPriority)

setPriorityNoSort

public void setPriorityNoSort(int newPriority)

setRemote

public void setRemote(boolean readOnly)

setReversedLink

public void setReversedLink(String reversedLink)

setTemplateId

public void setTemplateId(String inTemplate)

setUserRoles

public void setUserRoles(Set<String> roles)

Parameters:: strings -

setValid

public void setValid(boolean valid)

setValidater

public void setValidater(String validater)

setValidationDate

public void setValidationDate(Date validationDate)

setVirtualParent

public void setVirtualParent(List<MenuElement> newVirtualParent)

setVisible
```
public void setVisible(boolean b)
```
Parameters:

b -

toString
```
public String toString()
```
Overrides:

toString in class Object

updateLinkedData

public void updateLinkedData(ContentContext ctx)

notInSearch

public boolean notInSearch(ContentContext ctx)
                    throws Exception

Throws:: Exception

getI18n

public Map<String,String> getI18n(ContentContext ctx)
                                 throws Exception

get local i18n data

Parameters:: ctx -
Returns:
Throws:: Exception

getContact

public ContactBean getContact(ContentContext ctx)
                       throws Exception

get local i18n data

Parameters:: ctx -
Returns:
Throws:: Exception

isCacheable
```
public boolean isCacheable(ContentContext ctx)
                    throws Exception
```
check if the page is cacheable (static content)

Parameters:

ctx -

Returns:

Throws:

Exception

getNotCacheableComponent

public IContentVisualComponent getNotCacheableComponent(ContentContext ctx)
                                                 throws Exception

Throws:: Exception

getRealContentComponent

public IContentVisualComponent getRealContentComponent(ContentContext ctx)
                                                throws Exception

Throws:: Exception

getReferenceLanguage
```
public String getReferenceLanguage()
```

setReferenceLanguage

public void setReferenceLanguage(String referenceLanguage)

isBreakRepeat
```
public boolean isBreakRepeat()
```

setBreakRepeat

public void setBreakRepeat(boolean breakRepeat)

isShortURL
```
public boolean isShortURL()
```

getShortURL
```
public String getShortURL()
```

getShortURL

public String getShortURL(ContentContext ctx)
                   throws Exception

Throws:: Exception

getShortURL

public String getShortURL(ContentContext ctx,
                          boolean releaseCache)
                   throws Exception

Throws:: Exception

getShortLanguageURL

public String getShortLanguageURL(ContentContext ctx)
                           throws Exception

Throws:: Exception

setShortURL

public void setShortURL(String shortURL)

getStartPublishDate
```
public Date getStartPublishDate()
```

setStartPublishDate

public void setStartPublishDate(Date startPublishDate)

getEndPublishDate
```
public Date getEndPublishDate()
```

setEndPublishDate

public void setEndPublishDate(Date endPublishDate)

isTimeRange
```
public boolean isTimeRange()
```
return true if time range can modify the status of the page in the future.

Returns:

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getSharedName
```
public String getSharedName()
```

setSharedName

public void setSharedName(String sharedName)

isChildrenAssociation

public boolean isChildrenAssociation()

isRootChildrenAssociation

public boolean isRootChildrenAssociation()

isChildrenOfAssociation
```
public boolean isChildrenOfAssociation()
```
check if this page is a part of page association

Returns:

isDirectChildrenOfAssociation
```
public boolean isDirectChildrenOfAssociation()
```
check if this page is a direct children of page association

Returns:

getChildrenAssociationPage
```
public MenuElement getChildrenAssociationPage()
```
get the children association page of the current page.

Returns:

getRootOfChildrenAssociation
```
public MenuElement getRootOfChildrenAssociation()
```
get the root (parent) of the children association page

Returns:

getMainChildrenAssociation
```
public MenuElement getMainChildrenAssociation()
```
get the page marked as children association

Returns:

setChildrenAssociation

public void setChildrenAssociation(boolean childrenAssociation)

getFirstChild
```
public MenuElement getFirstChild()
```

equals

public boolean equals(ContentContext ctx,
                      MenuElement page)

equals

public boolean equals(ContentContext ctx,
                      MenuElement page,
                      boolean withChildren)

copyChildren

public void copyChildren(MenuElement page)

printInfo

public void printInfo(ContentContext ctx,
                      PrintStream out)

Specified by:: printInfo in interface IPrintInfo

getUrlNumber
```
public int getUrlNumber()
```
in case of same URL, this value in incremented. all URL factory (implementation of @IURLFactory) can use this number for create different URL.

Returns:

setUrlNumber

public void setUrlNumber(int urlNumber)

getEvent
```
public Event getEvent(ContentContext ctx)
               throws Exception
```
get event if menu element contains event info.

Parameters:

ctx -

Returns:

a event, null if this page does'nt contains event information

Throws:

Exception

getAreaClass

public String getAreaClass(ContentContext ctx,
                           String area)
                    throws Exception

Throws:: Exception

getEvents
```
public List<Event> getEvents(ContentContext ctx)
                      throws Exception
```
get event if menu element contains event info.

Parameters:

ctx -

Returns:

a event, null if this page does'nt contains event information

Throws:

Exception

isEditabled

public boolean isEditabled(ContentContext ctx)
                    throws Exception

Throws:: Exception

isReference
```
public boolean isReference(ContentContext ctx)
                    throws Exception
```
is a page with reference to other page, like page reference of children link

Parameters:

ctx -

Returns:

Throws:

Exception

getContentAsMap

public Map<String,Object> getContentAsMap(ContentContext ctx)
                                         throws IllegalArgumentException,
                                                IllegalAccessException,
                                                InvocationTargetException,
                                                Exception

Specified by:: getContentAsMap in interface IRestItem
Throws:: IllegalArgumentException; IllegalAccessException; InvocationTargetException; Exception

isRestWidthChildren
```
public boolean isRestWidthChildren()
```

setRestWidthChildren

public void setRestWidthChildren(boolean restWidthChildren)

getSavedParent
```
public String getSavedParent()
```

setSavedParent

public void setSavedParent(String freeData)

isTrash
```
public boolean isTrash()
```

isInTrash
```
public boolean isInTrash()
```

isLayout
```
public boolean isLayout()
```

getFinalSeoWeight
```
public int getFinalSeoWeight()
```

isNoIndex
```
public boolean isNoIndex()
```

getSeoWeight
```
public int getSeoWeight()
```

setSeoWeight

public void setSeoWeight(int searchEngineWeight)

needTemplate

public boolean needTemplate(ContentContext ctx,
                            String templateId)
                     throws Exception

check if page need a specific template.

Parameters:: templateId -
Returns:
Throws:: Exception

isModel
```
public boolean isModel()
```

setModel

public void setModel(boolean model)

isAdmin
```
public boolean isAdmin()
```

setAdmin

public void setAdmin(boolean admin)

getIpSecurityErrorPageName

public String getIpSecurityErrorPageName()

setIpSecurityErrorPageName

public void setIpSecurityErrorPageName(String ipSecurity)

isNeedValidation
```
public boolean isNeedValidation()
```

setNeedValidation

public void setNeedValidation(boolean needValidation)

isNoValidation
```
public boolean isNoValidation()
```

setNoValidation

public void setNoValidation(boolean noValidation)

getComponentTypes

public Map<String,List<String>> getComponentTypes(ContentContext ctx)
                                                 throws Exception

get list of component type by area

Parameters:: ctx -
Returns:: map of list with area as key
Throws:: Exception

getTaxonomy
```
public Set<String> getTaxonomy()
```
Specified by:

getTaxonomy in interface ITaxonomyContainer

setTaxonomy

public void setTaxonomy(Set<String> taxonomy)

isPublic

public boolean isPublic(ContentContext ctx)

getComponent

public IContentVisualComponent getComponent(ContentContext ctx,
                                            String id)
                                     throws Exception

Throws:: Exception

getHtmlId

public String getHtmlId(ContentContext ctx)

getHtmlSectionId

public String getHtmlSectionId(ContentContext ctx)

getPDFLayout

public String getPDFLayout(ContentContext ctx)
                    throws Exception

Throws:: Exception

getCss

public String getCss(ContentContext ctx)
              throws Exception

Throws:: Exception

getContentLanguage
```
public String getContentLanguage()
```
the content of this page is only for this language (use for import data only)

Returns:

a language code

setContentLanguage

public void setContentLanguage(String contentLanguage)

deleteComponent
```
public void deleteComponent(String lang)
```
delete components

Parameters:

lang - the lang to be deleted (null if all lang)

Class MenuElement

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_FOUND_PAGE

NULL_STRING

INSTANCE

PAGE_TYPE_DEFAULT

VOTES_MULTIPLY

SEO_HEIGHT_INHERITED

SEO_HEIGHT_NULL

SEO_HEIGHT_LOW

SEO_HEIGHT_NORMAL

SEO_HEIGHT_HIGHT

LAYOUTS_PREFIX

releaseCache

logger

Constructor Detail

MenuElement

Method Detail

getPageDescription

getMainContentLabel

isActive

getSmartPageDescription

getInstance

searchChild

getPageCached

setPageCached

finalize

addAccess

addChildMenuElement

addChildMenuElementAutoPriority

addChildMenuElementOnTop

addChildMenuElementOnBottom

addCompToDelete

addContent

addContent

addEditorRole

addEditorRoles

addVirtualParent

clearEditorGroups

getContentElementListMap

clearVirtualParent

countComponentInCtx

deleteCompList

endRendering

equals

getAccess

_getAllChildren

getAllChildrenList

getAllChildrenWithComponentType

getAllContent

getAllLocalContentBean

getAllResources

getAllVirtualPath

getBestLanguageContent

getBlocker

getCacheKey

getCategory

getFont

getForward

getSlogan

getColor

getBackgroundColor

getChildList

getChildMenuElements

getChildPosition

getPosition

getChildMenuElements

getChildMenuElementsList

getChildMenuElementsList

getChildMenuElementsWithVirtual

getChildMenuElementsWithVirtualList

getContent

getContentAsText

getContentAsList

getContent