com.atlassian.jira.plugin.navigation

Class HeaderFooterRendering

java.lang.Object

com.atlassian.jira.plugin.navigation.HeaderFooterRendering

public class HeaderFooterRendering
extends Object

This is called by the templating system to render most things header and footer. Originally this was in the header.jsp in its entirety but we moved it in here because Java code belongs in .java files. Sure its a ghetto but its a ghetto in the right place.

Since:

v6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_X_UA_COMPATIBLE

Constructor Summary

Constructors

Constructor and Description

HeaderFooterRendering(ApplicationProperties applicationProperties, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService, com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, ProductVersionDataBeanProvider productVersionDataBeanProvider, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, GoogleSiteVerification googleSiteVerification, BigPipeService bigPipeService)

Method Summary

Modifier and Type	Method and Description
void	flushBigPipe(javax.servlet.jsp.JspWriter out) This is to be called just before the </body> of every decorator, and ensures the correct resources and bigpipe data is included at the bottom of the page.
String	getKeyboardShortCutScript(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the keyboard shortcut script
String	getPageTitle(DecoratablePage.ParsedHead parsedHead) Called to to get the title of the web page
String	getPageTitle(com.opensymphony.module.sitemesh.Page originalPage) Called to to get the title of the web page
String	getRelativeResourcePrefix()
String	getXUACompatible(com.opensymphony.module.sitemesh.Page originalPage) Called to get the ua.compatible value
void	includeAccessLogImprints(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest)
void	includeFooters(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest)
void	includeGoogleSiteVerification(javax.servlet.jsp.JspWriter out) Writes the Google site verification code to the page if it's available.
void	includeMetadata(javax.servlet.jsp.JspWriter out) Includes the general meta data for JIRA in the page
void	includeResources(javax.servlet.jsp.JspWriter out) Drains and writes web resources to the page as HTML tags.
void	includeTopNavigation(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest, DecoratablePage.ParsedBody parsedBody) Called from header-nodecorator.jsp to render top navigation plugin point
void	includeTopNavigation(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest, com.opensymphony.module.sitemesh.Page page) Called from header.jsp to render top navigation plugin point
protected void	includeTopNavigation(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest, String selectedSection, Map<String,Object> webFragmentContext) Renders top navigation plugin point
void	includeVersionMetaTags(javax.servlet.jsp.JspWriter out) Includes the version meta data for JIRA in the page
void	includeWebPanels(javax.servlet.jsp.JspWriter out, String location)
void	requireCommonMetadata() Populates the web resource manager's meta data pool with common meta data needed for the page.
void	requireCommonResources() Called to require the standard global web resources that jira used on most pages.
void	requireLookAndFeelResources() Called to require the global look and feel web resources that jira used on most pages.

Methods inherited from class java.lang.Object

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

Field Detail

META_X_UA_COMPATIBLE

public static final String META_X_UA_COMPATIBLE

See Also:

Constant Field Values

Constructor Detail

HeaderFooterRendering

public HeaderFooterRendering(ApplicationProperties applicationProperties,
                             com.atlassian.plugin.PluginAccessor pluginAccessor,
                             com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService,
                             com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                             ProductVersionDataBeanProvider productVersionDataBeanProvider,
                             com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                             GoogleSiteVerification googleSiteVerification,
                             BigPipeService bigPipeService)

Method Detail

requireCommonResources

public void requireCommonResources()

Called to require the standard global web resources that jira used on most pages.

This is called from head-resources.jsp

requireLookAndFeelResources

public void requireLookAndFeelResources()

Called to require the global look and feel web resources that jira used on most pages.

This is called from head-resources.jsp

includeResources

public void includeResources(javax.servlet.jsp.JspWriter out)

Drains and writes web resources to the page as HTML tags.

This is called from head-resources.jsp

Parameters:

out - the JSP to write to

flushBigPipe

public void flushBigPipe(javax.servlet.jsp.JspWriter out)
                  throws IOException

This is to be called just before the </body> of every decorator, and ensures the correct resources and bigpipe data is included at the bottom of the page. This will block if necessary (up intil the WRM bigpipe deadline).

Throws:

IOException

includeTopNavigation

public void includeTopNavigation(javax.servlet.jsp.JspWriter out,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 com.opensymphony.module.sitemesh.Page page)

Called from header.jsp to render top navigation plugin point

Parameters:

out - the JSP to write to

httpServletRequest - the request in play

page - the SiteMesh original page

includeTopNavigation

public void includeTopNavigation(javax.servlet.jsp.JspWriter out,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 DecoratablePage.ParsedBody parsedBody)

Called from header-nodecorator.jsp to render top navigation plugin point

Parameters:

out - the JSP to write to

httpServletRequest - the request in play

parsedBody - the Parsed decorated body

includeFooters

public void includeFooters(javax.servlet.jsp.JspWriter out,
                           javax.servlet.http.HttpServletRequest httpServletRequest)

includeAccessLogImprints

public void includeAccessLogImprints(javax.servlet.jsp.JspWriter out,
                                     javax.servlet.http.HttpServletRequest httpServletRequest)

includeWebPanels

public void includeWebPanels(javax.servlet.jsp.JspWriter out,
                             String location)

getPageTitle

public String getPageTitle(com.opensymphony.module.sitemesh.Page originalPage)

Called to to get the title of the web page

Parameters:

originalPage - the decorated sitemesh page

Returns:

the title to use

getPageTitle

public String getPageTitle(DecoratablePage.ParsedHead parsedHead)

Called to to get the title of the web page

Parameters:

parsedHead - The parsed decorated page

Returns:

the title to use

getXUACompatible

public String getXUACompatible(com.opensymphony.module.sitemesh.Page originalPage)

Called to get the ua.compatible value

Parameters:

originalPage - the decorated sitemesh page

Returns:

the ua.compatible value

getRelativeResourcePrefix

public String getRelativeResourcePrefix()

Returns:

returns the relative resource prefix to use

includeVersionMetaTags

public void includeVersionMetaTags(javax.servlet.jsp.JspWriter out)

Includes the version meta data for JIRA in the page

Parameters:

out - the JSP writer

requireCommonMetadata

public void requireCommonMetadata()

Populates the web resource manager's meta data pool with common meta data needed for the page.

includeMetadata

public void includeMetadata(javax.servlet.jsp.JspWriter out)
                     throws IOException

Includes the general meta data for JIRA in the page

Parameters:

out - the JSP writer

Throws:

IOException

includeGoogleSiteVerification

public void includeGoogleSiteVerification(javax.servlet.jsp.JspWriter out)
                                   throws IOException

Writes the Google site verification code to the page if it's available.

Parameters:

out - the JSP writer

Throws:

IOException

getKeyboardShortCutScript

public String getKeyboardShortCutScript(javax.servlet.http.HttpServletRequest httpServletRequest)

Returns the keyboard shortcut script

Parameters:

httpServletRequest - the request in play

Returns:

the keyboard shortcut script

includeTopNavigation

protected void includeTopNavigation(javax.servlet.jsp.JspWriter out,
                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                    String selectedSection,
                                    Map<String,Object> webFragmentContext)

Renders top navigation plugin point

This code must be especially defensive against the plugin system, as failures here can result in blank pages being rendered.

Parameters:

out - the JSP to write to

httpServletRequest - the request in play

selectedSection - the selected section