|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.portalsite.view.SiteView
public class SiteView
This class defines the logical view of site content.
Field Summary | |
---|---|
static java.lang.String |
ALT_CURRENT_PAGE_PATH
ALT_CURRENT_PAGE_PATH - alternate expression used to match the current page |
static java.lang.String |
CURRENT_PAGE_PATH
CURRENT_PAGE_PATH - expression used to match the current page |
static java.lang.String |
CUSTOM_PAGE_NAVIGATIONS_MENU_NAME
CUSTOM_*_MENU_NAME - custom menu names |
static java.lang.String |
STANDARD_BACK_MENU_NAME
STANDARD_*_MENU_NAME - standard menu names |
static java.lang.String |
STANDARD_BREADCRUMBS_MENU_NAME
|
static java.lang.String |
STANDARD_NAVIGATIONS_MENU_NAME
|
static java.lang.String |
STANDARD_PAGES_MENU_NAME
|
Constructor Summary | |
---|---|
SiteView(PageManager pageManager)
SiteView - basic constructor |
|
SiteView(PageManager pageManager,
java.util.List searchPaths)
SiteView - validating constructor |
|
SiteView(PageManager pageManager,
java.util.Map locators)
SiteView - validating constructor |
|
SiteView(PageManager pageManager,
ProfileLocator locator)
SiteView - validating constructor |
|
SiteView(PageManager pageManager,
java.lang.String searchPaths)
SiteView - validating constructor |
|
SiteView(PageManager pageManager,
java.lang.String[] searchPaths)
SiteView - validating constructor |
Method Summary | |
---|---|
Page |
getManagedPage(Page page)
getManagedPage - get concrete page instance from page proxy; implemented here to hide view proxy manipulation from more general portal site implementation |
SiteViewMenuDefinitionLocator |
getMenuDefinitionLocator(Node node,
java.lang.String name)
getMenuDefinitionLocator - get named view node proxy menu definition locator; implemented here to hide view proxy manipulation from more general portal site implementation |
java.util.List |
getMenuDefinitionLocators(Node node)
getMenuDefinitionLocators - get list of view node proxy menu definition locators; implemented here to hide view proxy manipulation from more general portal site implementation |
java.util.List |
getNodeProxies(java.lang.String regexpPath,
Node currentNode,
boolean onlyViewable,
boolean onlyVisible)
getNodeProxies - get folder, page, or link proxies at relative or absolute path using simple path wildcards and character classes |
Node |
getNodeProxy(java.lang.String path,
Node currentNode,
boolean onlyViewable,
boolean onlyVisible)
getNodeProxy - get single folder, page, or link proxy at relative or absolute path |
PageManager |
getPageManager()
getPageManager - return PageManager component instance |
java.lang.String |
getProfileLocatorName(Node node)
getProfileLocatorName - get view node proxy profile locator name; implemented here to hide view proxy manipulation from more general portal site implementation |
Folder |
getRootFolderProxy()
getRootFolderProxy - create and return root folder proxy instance |
java.util.List |
getSearchPaths()
getSearchPaths - return ordered search paths list that defines this view |
java.lang.String |
getSearchPathsString()
getSearchPathsString - return search paths as string |
java.util.List |
getStandardMenuDefinitionLocators()
getStandardMenuDefinitionLocators - get list of available standard menu definition locators |
java.util.Set |
getStandardMenuNames()
getStandardMenuNames - get set of available standard menu names |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CURRENT_PAGE_PATH
public static final java.lang.String ALT_CURRENT_PAGE_PATH
public static final java.lang.String STANDARD_BACK_MENU_NAME
public static final java.lang.String STANDARD_BREADCRUMBS_MENU_NAME
public static final java.lang.String STANDARD_PAGES_MENU_NAME
public static final java.lang.String STANDARD_NAVIGATIONS_MENU_NAME
public static final java.lang.String CUSTOM_PAGE_NAVIGATIONS_MENU_NAME
Constructor Detail |
---|
public SiteView(PageManager pageManager, java.util.List searchPaths)
pageManager
- PageManager component instancesearchPaths
- list of search paths in string or search path
object formpublic SiteView(PageManager pageManager, java.lang.String[] searchPaths)
pageManager
- PageManager component instancesearchPaths
- array of search pathspublic SiteView(PageManager pageManager, java.lang.String searchPaths)
pageManager
- PageManager component instancesearchPaths
- string of comma separated search pathspublic SiteView(PageManager pageManager, ProfileLocator locator)
pageManager
- PageManager component instancelocator
- profile locator search specificationpublic SiteView(PageManager pageManager, java.util.Map locators)
pageManager
- PageManager component instancelocators
- map of named profile locator search specificationspublic SiteView(PageManager pageManager)
pageManager
- PageManager component instanceMethod Detail |
---|
public PageManager getPageManager()
public java.util.List getSearchPaths()
public java.lang.String getSearchPathsString()
public Folder getRootFolderProxy() throws FolderNotFoundException
FolderNotFoundException
- if not found
java.lang.SecurityException
- if view access not grantedpublic Node getNodeProxy(java.lang.String path, Node currentNode, boolean onlyViewable, boolean onlyVisible) throws NodeNotFoundException
path
- single node pathcurrentNode
- current folder or page for relative paths or nullonlyViewable
- node required to be viewableonlyVisible
- node required to be visible, (or current)
NodeNotFoundException
- if not found
java.lang.SecurityException
- if view access not grantedpublic java.util.List getNodeProxies(java.lang.String regexpPath, Node currentNode, boolean onlyViewable, boolean onlyVisible)
regexpPath
- regular expression node pathcurrentNode
- current folder or page for relative paths or nullonlyViewable
- nodes required to be viewable flagonlyVisible
- node required to be visible, (or current)
public java.util.Set getStandardMenuNames()
public java.util.List getStandardMenuDefinitionLocators()
public java.util.List getMenuDefinitionLocators(Node node)
node
- node proxy
public SiteViewMenuDefinitionLocator getMenuDefinitionLocator(Node node, java.lang.String name)
node
- node proxyname
- menu definition name
public java.lang.String getProfileLocatorName(Node node)
node
- node proxy
public Page getManagedPage(Page page)
page
- page proxy
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |