Package | Description |
---|---|
org.hippoecm.hst.content.beans.standard | |
org.hippoecm.hst.core.sitemenu |
The org.hippoecm.hst.core.sitemenu package defines the API for the HST Core SiteMenu
|
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
HippoBean.getAvailableTranslations()
|
<T extends HippoBean> |
HippoDocumentBean.getAvailableTranslations(Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getCanonicalBean()
Returns the canonical version of the current
HippoBean or null in case that the backing Node is pure virtual, which
is the case for example for some faceted navigation nodes. |
String |
HippoDocumentBean.getCanonicalHandlePath()
Returns the jcr path of the backing canonical handle jcr node or
null when |
String |
HippoDocumentBean.getCanonicalHandleUUID()
Returns the jcr uuid of the backing canonical handle jcr node or
null when |
String |
HippoBean.getCanonicalPath()
Returns the jcr path of the backing canonical (physical) jcr node or
null when |
String |
HippoBean.getCanonicalUUID()
Returns the jcr uuid of the backing canonical (physical) jcr node or
null when |
default String |
HippoBean.getComparePath()
Returns the canonical path
|
String |
HippoHtmlBean.getContent()
Since in the Page Model API (PMA) we do not want to serialize the raw String content (but instead a rewritten
content resolving internal links), we ignore the
HippoHtmlBean.getContent() in PMA via @PageModelIgnore |
String |
HippoHtmlBean.getDisplayName() |
List<HippoDocumentBean> |
HippoFolderBean.getDocuments()
This method returns the
List of HippoDocumentBean s in the order they are in the repository. |
Map<Object,Object> |
HippoBean.getEqualComparator()
A convenience method capable of comparing two HippoBean instances for you for the underlying jcr node.
|
List<HippoFolderBean> |
HippoFolderBean.getFolders() |
String |
IdentifiableContentBean.getIdentifier()
This returns the identifier of the backing provider for this bean, for example some UUID or
/documents/content/myprojec/news/article or http://www.example.com/foo/bar, or a RDBMS id, etc
It is not allowed for any implementation to return
null |
BigDecimal |
HippoResourceBean.getLengthKB()
Return size in kilobytes
|
BigDecimal |
HippoResourceBean.getLengthMB()
Return size in kilobytes
|
Locale |
HippoTranslated.getLocale()
Returns the
Locale for content bean. |
String |
HippoHtmlBean.getName() |
javax.jcr.Node |
HippoBean.getNode()
This returns the backing jcr node for this bean.
|
HippoBean |
HippoBean.getParentBean()
Returns the parent bean wrt this bean.
|
String |
HippoBean.getPath()
This returns the absolute path of the backing jcr node for this bean, for example /documents/content/myprojec/news/article
When the jcr node is virtual, it returns the virtual path.
|
Map<String,Object> |
HippoBean.getProperties()
Same as
#getProperty(String) , where getProperty is only there for having a nice .getProperty['propname'] in jsp expression language |
Map<String,Object> |
HippoBean.getProperty() |
HippoBean |
HippoMirrorBean.getReferencedBean()
When you want the HippoBean that this mirror represents, you can use this method.
|
default String |
HippoMirrorBean.getRepresentationId()
in the Page Model API we do not want to show uuid for nodes below a document (compound)
|
default String |
HippoHtmlBean.getRepresentationId()
in the Page Model API we do not want to show uuid for nodes below a document (compound)
|
default String |
HippoResourceBean.getRepresentationId()
in the Page Model API we do not want to show uuid for nodes below a document (compound)
|
default String |
HippoCompoundBean.getRepresentationId()
in the Page Model API we do not want to show uuid for nodes below a document (compound)
|
JCRValueProvider |
HippoBean.getValueProvider() |
boolean |
HippoResourceBean.isBlank()
Return
true if this resource contains blank data and should not be used by the frontend. |
boolean |
HippoBean.isHippoDocumentBean() |
boolean |
HippoBean.isHippoFolderBean() |
boolean |
HippoBean.isLeaf() |
boolean |
HippoBean.isVersionedNode() |
Modifier and Type | Method and Description |
---|---|
HstSiteMenuItem |
HstSiteMenu.getDeepestExpandedItem()
This utility method is valuable for creating repository based navigations, as you can easily get the deepest selected item, which might
in turn need repository based menu build below it
|
EditableMenuItem |
EditableMenu.getDeepestExpandedItem() |
EditableMenu |
EditableMenuItem.getEditableMenu() |
EditableMenu |
HstSiteMenu.getEditableMenu()
Returns an
instance from this HstSiteMenu. |
String |
CommonMenuItem.getExternalLink()
When this method does not return null, then by default
CommonMenuItem.getHstLink() will return null even
if the sitemenu item has a sitemap reference path defined |
HstLink |
CommonMenuItem.getHstLink() |
HstSiteMenu |
HstSiteMenuItem.getHstSiteMenu() |
HstSiteMenus |
HstSiteMenu.getHstSiteMenus() |
HstSiteMenus |
EditableMenu.getHstSiteMenus() |
Map<String,String> |
HstSiteMenuItem.getLocalParameters() |
HstSiteMenuItem |
HstSiteMenuItem.getParentItem() |
EditableMenuItem |
EditableMenuItem.getParentItem() |
EditableMenuItem |
EditableMenu.getSelectMenuItem()
Note: the method should have been called getSelectedMenuItem because of a
historical typo it is called getSelectMenuItem
|
HstSiteMenuItem |
HstSiteMenu.getSelectSiteMenuItem() |
boolean |
CommonMenuItem.isExpanded()
A sitemenu item is expanded if one of its descendants is selected or if it is selected itself
|
boolean |
CommonMenu.isExpanded()
Based on the request, the implementation should be able to indicate whether this HstSiteMenu is expanded
|
boolean |
CommonMenuItem.isSelected() |
Copyright © 2008–2020 Hippo B.V. (http://www.onehippo.com). All rights reserved.