org.randombits.support.confluence

Class DefaultContextAssistant

java.lang.Object

org.randombits.support.confluence.DefaultContextAssistant

All Implemented Interfaces:

ContextAssistant

public class DefaultContextAssistant
extends java.lang.Object
implements ContextAssistant

Default implementation of ContextAssistant.

Author:

David Peterson

Constructor Summary

Constructors

Constructor and Description
DefaultContextAssistant(com.atlassian.confluence.pages.templates.PageTemplateManager pageTemplateManager, com.atlassian.confluence.pages.PageManager pageManager)

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 accessible 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)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultContextAssistant

public DefaultContextAssistant(com.atlassian.confluence.pages.templates.PageTemplateManager pageTemplateManager,
                       com.atlassian.confluence.pages.PageManager pageManager)

Method Detail

getPageTemplate

public 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 accessible 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.

Specified by:

getPageTemplate in interface ContextAssistant

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

public 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.

Specified by:

getPageTemplates in interface ContextAssistant

Parameters:

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

Returns:

The list of available page templates.

isViewAction

public 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.

Specified by:

isViewAction in interface ContextAssistant

Parameters:

ctx - The page context.

Returns:

true if the content is in 'view' mode.

isEditAction

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

Returns true if we are editing content.

Specified by:

isEditAction in interface ContextAssistant

Parameters:

ctx - The page context.

Returns:

true if we are in edit mode.

isDashboardAction

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

Check if we are on the dashboard.

Specified by:

isDashboardAction in interface ContextAssistant

Parameters:

ctx - The page context.

Returns:

true if we are on the dashboard.

isTemplateAction

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

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

Specified by:

isTemplateAction in interface ContextAssistant

Parameters:

ctx - The page context.

Returns:

true if we are operating on a template.

isCurrentAction

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

Checks if the specified class is the current action.

Specified by:

isCurrentAction in interface ContextAssistant

Parameters:

actionClass - The class to check.

Returns:

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

isDefaultDisplay

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

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

Specified by:

isDefaultDisplay in interface ContextAssistant

Parameters:

ctx - The current page context.

Returns:

true if there is no special display in place.

isPrintableDisplay

public 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.

Specified by:

isPrintableDisplay in interface ContextAssistant

Parameters:

ctx - The page context.

Returns:

true if the printable view is being displayed.

isPDFDisplay

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

Specified by:

isPDFDisplay in interface ContextAssistant

isWordDisplay

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

Specified by:

isWordDisplay in interface ContextAssistant

isPreviewDisplay

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

Specified by:

isPreviewDisplay in interface ContextAssistant

isRecentlyUpdatedFor

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

Specified by:

isRecentlyUpdatedFor in interface ContextAssistant

getCurrentPageTemplate

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

Specified by:

getCurrentPageTemplate in interface ContextAssistant