com.atlassian.jira.plugin.navigation
Class HeaderFooterRendering

java.lang.Object
  extended by 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
static String META_X_UA_COMPATIBLE
           
 
Constructor Summary
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)
           
 
Method Summary
 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 includeFooters(javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest httpServletRequest)
          Called from footer.jsp to render to render footer plugin point
 void includeHeadResources(javax.servlet.jsp.JspWriter out)
          Called to include the standard global web resources that jira used on most pages.
 void includeMetadata(javax.servlet.jsp.JspWriter out)
          Includes the general meta data for JIRA in the page
 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 This code must be especially defensive against the plugin system, as failures here can result in blank pages being rendered.
 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)
          Called to include web panels of a named location into the JSP page
 
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)
Method Detail

includeHeadResources

public void includeHeadResources(javax.servlet.jsp.JspWriter out)
Called to include the standard global web resources that jira used on most pages.

This is called from head-resources.jsp

Parameters:
out - the JSP to write to

includeTopNavigation

public void includeTopNavigation(javax.servlet.jsp.JspWriter out,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 com.opensymphony.module.sitemesh.Page page)
                          throws IOException
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
Throws:
IOException

includeTopNavigation

public void includeTopNavigation(javax.servlet.jsp.JspWriter out,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 DecoratablePage.ParsedBody parsedBody)
                          throws IOException
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
Throws:
IOException

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

includeFooters

public void includeFooters(javax.servlet.jsp.JspWriter out,
                           javax.servlet.http.HttpServletRequest httpServletRequest)
                    throws IOException
Called from footer.jsp to render to render footer plugin point

Parameters:
out - the JSP to write to
httpServletRequest - the request in play
Throws:
IOException

includeWebPanels

public void includeWebPanels(javax.servlet.jsp.JspWriter out,
                             String location)
                      throws IOException
Called to include web panels of a named location into the JSP page

Parameters:
out - the JSP to write to
location - the named location of the web panel like alt.general
Throws:
IOException

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)
                            throws IOException
Includes the version meta data for JIRA in the page

Parameters:
out - the JSP writer
Throws:
IOException

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

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


Copyright © 2002-2014 Atlassian. All Rights Reserved.