com.atlassian.confluence.themes
Class GlobalHelper
java.lang.Object
com.atlassian.confluence.themes.GlobalHelper
- All Implemented Interfaces:
- ThemeHelper
- Direct Known Subclasses:
- AttachmentHelper, MailHelper, PageHelper
public class GlobalHelper
- extends Object
- implements ThemeHelper
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
GlobalHelper
public GlobalHelper()
GlobalHelper
public GlobalHelper(ConfluenceActionSupport action)
getText
public String getText(String property)
- Specified by:
getText
in interface ThemeHelper
getText
public String getText(String property,
Object[] args)
getAction
public ConfluenceActionSupport getAction()
- Specified by:
getAction
in interface ThemeHelper
getDomainName
public String getDomainName()
- Specified by:
getDomainName
in interface ThemeHelper
getSiteTitle
public String getSiteTitle()
getSpace
public Space getSpace()
getSpaceKey
public String getSpaceKey()
- Specified by:
getSpaceKey
in interface ThemeHelper
getSpaceName
public String getSpaceName()
- Specified by:
getSpaceName
in interface ThemeHelper
getSpaceType
public String getSpaceType()
getPage
public AbstractPage getPage()
getWikiStyleRenderer
public com.atlassian.renderer.WikiStyleRenderer getWikiStyleRenderer()
renderConfluenceMacro
public String renderConfluenceMacro(String wikiCall)
- Specified by:
renderConfluenceMacro
in interface ThemeHelper
renderConfluenceMacro
public String renderConfluenceMacro(String messageFormatString,
String... args)
getLabel
public DisplayableLabel getLabel()
getBreadcrumbs
public List<Breadcrumb> getBreadcrumbs()
- Returns a list of breadcrumbs ending with the current action.
The current action is usually the last breadcrumb, represented by text (rather than a link) which is an i18n version of the action
name. The action's parent is determined in one of the following ways (given that there is no other convention for
the determination of an action's place in the hierachy) :
- Action class - hardcoded class test, least scalable
- Action package - hardcoded string test, scalable but only reliable if classes in correct location
- Action interface - existing interfaces can be used, but adding interfaces just for this is ugly (ask CM)
- Action URL - from xwork (?) or servlet request URL, this is valid in that the URL hierarchy is the one we
expose to the user, so a crumb path that matches it is intuitive.
- Action method - getParentBreadcrumb applied to a concrete or abstract Action gives control to the action
itself.
This method is currently a hack due to our ugly action hierarchy.
The logic for all this were in the velocity templates and have been centralized in one location, here.
It should be cleaned up later on (no dependency on request URL or package name).
- Returns:
- a list of breadcrumbs ending with the current action
getEllipsisCrumbs
public List<PageBreadcrumb> getEllipsisCrumbs(List<Breadcrumb> breadcrumbs)
- Returns a list of page breadcrumbs that should be hidden in an ellipsis. It will always exclude the last
page breadcrumb from the list.
Copyright © 2003-2012 Atlassian. All Rights Reserved.