org.randombits.support.confluence

Interface ContextAssistant

All Known Implementing Classes:

DefaultContextAssistant

public interface ContextAssistant

Author:

David Peterson

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.confluence.pages.templates.PageTemplate	getCurrentPageTemplate(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)
com.atlassian.confluence.pages.templates.PageTemplate	getPageTemplate(java.lang.String templateName, com.atlassian.confluence.spaces.Space space) Returns the page template with the specified name, if it is accessable from the context of the specified spaces, otherwise searches the global space for a matching template and returns that.
java.util.List<com.atlassian.confluence.pages.templates.PageTemplate>	getPageTemplates(com.atlassian.confluence.spaces.Space space) Returns the list of all page templates available in the context of the specified spaces, including any global templates.
boolean	isCurrentAction(java.lang.Class<? extends com.opensymphony.xwork.Action> actionClass) Checks if the specified class is the current action.
boolean	isDashboardAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Check if we are on the dashboard.
boolean	isDefaultDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Returns true if the current view is the default display (ie not printable, etc).
boolean	isEditAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Returns true if we are editing content.
boolean	isPDFDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)
boolean	isPreviewDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)
boolean	isPrintableDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Returns true if the current view is printable - either the standard 'print' view, Word or PDF.
boolean	isRecentlyUpdatedFor(com.atlassian.confluence.core.ContentEntityObject ceo, java.lang.Object user)
boolean	isTemplateAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Returns true if the current page context is within a page template action.
boolean	isViewAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx) Returns true if the current action is the view option for the current content.
boolean	isWordDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Method Detail

getPageTemplate

com.atlassian.confluence.pages.templates.PageTemplate getPageTemplate(java.lang.String templateName,
                                                                    com.atlassian.confluence.spaces.Space space)

Returns the page template with the specified name, if it is accessable from the context of the specified spaces, otherwise searches the global space for a matching template and returns that. If no space is specified, only global templates are returned.

Parameters:

templateName - The name of the template.

space - The space to search, or null to only search global templates.

Returns:

The page template, or null.

getPageTemplates

java.util.List<com.atlassian.confluence.pages.templates.PageTemplate> getPageTemplates(com.atlassian.confluence.spaces.Space space)

Returns the list of all page templates available in the context of the specified spaces, including any global templates. If no space is specified only global templates will be returned.

Parameters:

space - The space to search, or null to only list global templates.

Returns:

The list of available page templates.

isViewAction

boolean isViewAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Returns true if the current action is the view option for the current content. If we are not viewing any editable content, false is returned.

Parameters:

ctx - The page context.

Returns:

true if the content is in 'view' mode.

isEditAction

boolean isEditAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Returns true if we are editing content.

Parameters:

ctx - The page context.

Returns:

true if we are in edit mode.

isDashboardAction

boolean isDashboardAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Check if we are on the dashboard.

Parameters:

ctx - The page context.

Returns:

true if we are on the dashboard.

isTemplateAction

boolean isTemplateAction(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Returns true if the current page context is within a page template action.

Parameters:

ctx - The page context.

Returns:

true if we are operating on a template.

isCurrentAction

boolean isCurrentAction(java.lang.Class<? extends com.opensymphony.xwork.Action> actionClass)

Checks if the specified class is the current action.

Parameters:

actionClass - The class to check.

Returns:

true if current action is an instance of the specified class.

isDefaultDisplay

boolean isDefaultDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Returns true if the current view is the default display (ie not printable, etc).

Parameters:

ctx - The current page context.

Returns:

true if there is no special display in place.

isPrintableDisplay

boolean isPrintableDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

Returns true if the current view is printable - either the standard 'print' view, Word or PDF.

Parameters:

ctx - The page context.

Returns:

true if the printable view is being displayed.

isPDFDisplay

boolean isPDFDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

isWordDisplay

boolean isWordDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

isPreviewDisplay

boolean isPreviewDisplay(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)

isRecentlyUpdatedFor

boolean isRecentlyUpdatedFor(com.atlassian.confluence.core.ContentEntityObject ceo,
                           java.lang.Object user)

getCurrentPageTemplate

com.atlassian.confluence.pages.templates.PageTemplate getCurrentPageTemplate(com.atlassian.confluence.content.render.xhtml.ConversionContext ctx)