Package org.ametys.web.repository.dom

Class AbstractPagesContainerElement<A extends PagesContainer>

java.lang.Object

org.ametys.core.util.dom.AbstractAmetysNode

org.ametys.core.util.dom.AbstractAmetysElement

org.ametys.core.util.dom.AbstractWrappingAmetysElement<A>

org.ametys.plugins.repository.dom.AmetysObjectElement<A>

org.ametys.web.repository.dom.AbstractPagesContainerElement<A>

Type Parameters:

A - the actual type of the wrapped PagesContainer.

All Implemented Interfaces:

Element, Node

Direct Known Subclasses:

PageElement, SitemapElement

public abstract class AbstractPagesContainerElement<A extends PagesContainer>
extends AmetysObjectElement<A>

DOM Element wrapping a PagesContainer.

Field Summary

Fields

Modifier and Type	Field	Description
private AmetysObjectIterable<? extends Page>	_children
protected String	_currentPagePath	The path of the wrapped page.
protected long	_depth	The depth of childs to display
protected boolean	_includeInvisiblePages	should child pages displays invisible page
protected RestrictedPagePolicy	_policy	the RestrictedPagePolicy of the current site.
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler.
protected RightManager	_rightManager	The right manager
protected UserIdentity	_userIdentity	The identity of the current user.
static String	NAMESPACE_PREFIX	Prefix for sitemap namespace.
static String	NAMESPACE_URI	URI for sitemap namespace.

Fields inherited from class org.ametys.core.util.dom.AbstractWrappingAmetysElement

_object

Fields inherited from class org.ametys.core.util.dom.AbstractAmetysElement

_parent

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor	Description
AbstractPagesContainerElement(A pagesContainer, RightManager rightManager, RenderingContextHandler renderingContextHandler, String currentPagePath, UserIdentity userIdentity, long depth, boolean includeInvisiblePages)	Constructor.
AbstractPagesContainerElement(A pagesContainer, AbstractPagesContainerElement<PagesContainer> parent, RightManager rightManager, RenderingContextHandler renderingContextHandler, String currentPagePath, UserIdentity userIdentity, long depth, boolean includeInvisiblePages)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) AmetysObjectIterable<? extends Page>	getChildren()
Node	getFirstChild()
String	getNamespaceURI()
Node	getNextSibling()
boolean	hasChildNodes()

Methods inherited from class org.ametys.plugins.repository.dom.AmetysObjectElement

_lookupAttributes, getTagName

Methods inherited from class org.ametys.core.util.dom.AbstractWrappingAmetysElement

getWrappedObject

Methods inherited from class org.ametys.core.util.dom.AbstractAmetysElement

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getElementsByTagName, getElementsByTagNameNS, getLocalName, getNodeName, getNodeType, getParentNode, getSchemaTypeInfo, getTextContent, hasAttribute, hasAttributeNS, hasAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from class org.ametys.core.util.dom.AbstractAmetysNode

_getChildNodes, appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getLastChild, getNodeValue, getOwnerDocument, getPrefix, getPreviousSibling, getUserData, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getLastChild, getNodeValue, getOwnerDocument, getPrefix, getPreviousSibling, getUserData, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

NAMESPACE_PREFIX

public static final String NAMESPACE_PREFIX

Prefix for sitemap namespace.

See Also:

Constant Field Values

NAMESPACE_URI

public static final String NAMESPACE_URI

URI for sitemap namespace.

See Also:

Constant Field Values

_rightManager

protected RightManager _rightManager

The right manager

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler.

_currentPagePath

protected String _currentPagePath

The path of the wrapped page.

_userIdentity

protected UserIdentity _userIdentity

The identity of the current user.

_policy

protected RestrictedPagePolicy _policy

the RestrictedPagePolicy of the current site.

_includeInvisiblePages

protected boolean _includeInvisiblePages

should child pages displays invisible page

_depth

protected long _depth

The depth of childs to display

_children

private AmetysObjectIterable<? extends Page> _children

Constructor Detail

AbstractPagesContainerElement

public AbstractPagesContainerElement(A pagesContainer,
                                     RightManager rightManager,
                                     RenderingContextHandler renderingContextHandler,
                                     String currentPagePath,
                                     UserIdentity userIdentity,
                                     long depth,
                                     boolean includeInvisiblePages)

Constructor.

Parameters:

pagesContainer - the wrapped PagesContainer.

rightManager - the right manager

currentPagePath - the path of the current page, or null if none.

renderingContextHandler - the RenderingContextHandler.

userIdentity - the identity of the current user, or null if none.

depth - The depth to get. 1 for root pages, 0 for this node only, -1 for infinite.

includeInvisiblePages - Should return child invisible pages

AbstractPagesContainerElement

public AbstractPagesContainerElement(A pagesContainer,
                                     AbstractPagesContainerElement<PagesContainer> parent,
                                     RightManager rightManager,
                                     RenderingContextHandler renderingContextHandler,
                                     String currentPagePath,
                                     UserIdentity userIdentity,
                                     long depth,
                                     boolean includeInvisiblePages)

Constructor.

Parameters:

pagesContainer - the wrapped PagesContainer.

parent - the parent container.

rightManager - the right manager

currentPagePath - the path of the current page, or null if none.

renderingContextHandler - the RenderingContextHandler.

userIdentity - the identity of the current user, or null if none.

depth - The depth to get. 1 for root pages, 0 for this node only, -1 for infinite.

includeInvisiblePages - Should return child invisible pages

Method Detail

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

Overrides:

getNamespaceURI in class AbstractAmetysNode

getChildren

AmetysObjectIterable<? extends Page> getChildren()

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

Overrides:

hasChildNodes in class AmetysObjectElement<A extends PagesContainer>

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

Overrides:

getFirstChild in class AmetysObjectElement<A extends PagesContainer>

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

Overrides:

getNextSibling in class AmetysObjectElement<A extends PagesContainer>