LayoutTag (DSpace JSP-UI 5.5 API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - javax.servlet.jsp.tagext.BodyTagSupport
  - - org.dspace.app.webui.jsptag.LayoutTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class LayoutTag
extends javax.servlet.jsp.tagext.BodyTagSupport
```
Tag for HTML page layout ("skin").
This tag sets request attributes that should be used by the header and footer to render the page appropriately:
- dspace.layout.title - title of page
- dspace.layout.locbar - value will Boolean true or false
- dspace.layout.parenttitles - a List of Strings corresponding with titles to put in the location bar. Only set if dspace.layout.locbar is true
- dspace.layout.parentlinks - a List of Strings corresponding with links to put in the location bar. Empty strings mean no link. Will only be set if dspace.layout.locbar is true.
- dspace.layout.navbar - value will be "off", or the navigation bar to include, e.g. "/layout/navbar_default.jsp"
- dspace.layout.sidebar - contents of the sidebar
- dspace.current.user - the EPerson currently logged in, or null if anonymous access
- dspace.layout.feeddata - String. "NONE" means no feed from this page; otherwise the Handle of object (community or collection) the feed is from
- dspace.layout.linkparts - String[]. A cycling sequence of: 2nd part of MIME type (e.g. rdf+rss); title of feed; path component to go after /feed/ for the actual feed URL (e.g. rss_1.0). Hence, this array will have 3n elements where n is the number of feeds.
* Additionally the following parameter may be set elsewhere in a Servlet.
- dspace.layout.head - extra data to include verbatim in the <head> element of the page
Furthermore it sets the content type of the response to text/html using UTF-8 to ensure this will be returned in the HTTP header.
Version:

$Revision$

Author:

Robert Tansley

See Also:
Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
  bodyContent
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
  EVAL_BODY_BUFFERED, EVAL_BODY_TAG
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor and Description

LayoutTag()

Constructors
Constructor and Description
`LayoutTag()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`doEndTag()`
`int`	`doStartTag()`
`String`	`getFeedData()` Get the value of feedData.
`String`	`getLocbar()` Get the value of locbar.
`String`	`getNavbar()` Get the value of navbar.
`String`	`getNocache()` Get the value of sidebar.
`String`	`getParentlink()` Get the value of parentlink.
`String`	`getParenttitle()` Get the value of parentTitle.
`String`	`getParenttitlekey()` get parent title key (from message dictionary)
`String`	`getSidebar()` Get the value of sidebar.
`String`	`getStyle()` Get the value of style.
`String`	`getTitle()` Get the value of title.
`String`	`getTitlekey()`
`void`	`setFeedData(String v)` Set the value of feedData.
`void`	`setLocbar(String v)` Set the value of locbar.
`void`	`setNavbar(String v)` Set the value of navbar.
`void`	`setNocache(String v)` Set the value of sidebar.
`void`	`setParentlink(String v)` Set the value of parentlink.
`void`	`setParenttitle(String v)` Set the value of parent.
`void`	`setParenttitlekey(String parentTitleKey)` set parent title key (from message dictionary)
`void`	`setSidebar(String v)` Set the value of sidebar.
`void`	`setStyle(String v)` Set the value of style.
`void`	`setTitle(String v)` Set the value of title.
`void`	`setTitlekey(String titleKey)`

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent

- Constructor Detail
  - LayoutTag
```
public LayoutTag()
```
- Method Detail
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doStartTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - getTitle
```
public String getTitle()
```
    Get the value of title.
    
    Returns:
    Value of title.
  - setTitle
```
public void setTitle(String v)
```
    Set the value of title.
    
    Parameters:
    v - Value to assign to title.
  - getTitlekey
```
public String getTitlekey()
```
    Returns:
    Returns the titleKey.
  - setTitlekey
```
public void setTitlekey(String titleKey)
```
    Parameters:
    titleKey - The titleKey to set.
  - getNavbar
```
public String getNavbar()
```
    Get the value of navbar.
    
    Returns:
    Value of navbar.
  - setNavbar
```
public void setNavbar(String v)
```
    Set the value of navbar.
    
    Parameters:
    v - Value to assign to navbar.
  - getLocbar
```
public String getLocbar()
```
    Get the value of locbar.
    
    Returns:
    Value of locbar.
  - setLocbar
```
public void setLocbar(String v)
```
    Set the value of locbar.
    
    Parameters:
    v - Value to assign to locbar.
  - getParenttitle
```
public String getParenttitle()
```
    Get the value of parentTitle.
    
    Returns:
    Value of parentTitle.
  - setParenttitle
```
public void setParenttitle(String v)
```
    Set the value of parent.
    
    Parameters:
    v - Value to assign to parent.
  - getParenttitlekey
```
public String getParenttitlekey()
```
    get parent title key (from message dictionary)
    
    Returns:
    Returns the parentTitleKey.
  - setParenttitlekey
```
public void setParenttitlekey(String parentTitleKey)
```
    set parent title key (from message dictionary)
    
    Parameters:
    parentTitleKey - The parentTitleKey to set.
  - getParentlink
```
public String getParentlink()
```
    Get the value of parentlink.
    
    Returns:
    Value of parentlink.
  - setParentlink
```
public void setParentlink(String v)
```
    Set the value of parentlink.
    
    Parameters:
    v - Value to assign to parentlink.
  - getStyle
```
public String getStyle()
```
    Get the value of style.
    
    Returns:
    Value of style.
  - setStyle
```
public void setStyle(String v)
```
    Set the value of style.
    
    Parameters:
    v - Value to assign to style.
  - getSidebar
```
public String getSidebar()
```
    Get the value of sidebar.
    
    Returns:
    Value of sidebar.
  - setSidebar
```
public void setSidebar(String v)
```
    Set the value of sidebar.
    
    Parameters:
    v - Value to assign to sidebar.
  - getNocache
```
public String getNocache()
```
    Get the value of sidebar.
    
    Returns:
    Value of sidebar.
  - setNocache
```
public void setNocache(String v)
```
    Set the value of sidebar.
    
    Parameters:
    v - Value to assign to sidebar.
  - getFeedData
```
public String getFeedData()
```
    Get the value of feedData.
    
    Returns:
    Value of feedData.
  - setFeedData
```
public void setFeedData(String v)
```
    Set the value of feedData.
    
    Parameters:
    v - Value to assign to feedData.

Class LayoutTag

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Detail

LayoutTag

Method Detail

doStartTag

doEndTag

getTitle

setTitle

getTitlekey

setTitlekey

getNavbar

setNavbar

getLocbar

setLocbar

getParenttitle

setParenttitle

getParenttitlekey

setParenttitlekey

getParentlink

setParentlink

getStyle

setStyle

getSidebar

setSidebar

getNocache

setNocache

getFeedData

setFeedData