ToolbarTag

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - com.redhat.rhn.frontend.taglibs.ToolbarTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class ToolbarTag
extends javax.servlet.jsp.tagext.TagSupport
```
The ToolbarTag generates a toolbar showing the page title, optional help link, and action buttons to the right of the page.
```
   <rhn:toolbar base="h1" img="/img/somegraphic.gif">
 
```
Basic Attributes:
- base - base html tag for wrapping the toolbar.
- icon - name of the icon (css class) to be displayed to the left of the page title
- iconAlt - alternate text for the icon. Don't use it if the icon decorates text.
- img - img url which is displayed to the left of the page title.
- altImg - alt text for the img
- helpUrl - link to the help pages.
Action Attributes:
- create button
  - url (required) - location of action button
  - acl - Acl limiting view of button
  - type (required) - type action is taken upon i.e. user
- delete button
  - url (required) - location of action button
  - acl - Acl limiting view of button
  - type (required) - type action is taken upon i.e. user
- misc link
  - url (required) - link location
  - acl - Acl limiting view of link
  - text (required) - link text
  - alt (required) - alternate link text
  - icon (required) - icon to be displayed for link
  - img (required if no icon specified) - image to be displayed for link
See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- 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

ToolbarTag()
Constructor for tag.

Constructors
Constructor and Description
`ToolbarTag()` Constructor for tag.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doEndTag()`
`int`	`doStartTag()`
`java.lang.String`	`getAclMixins()`
`java.lang.String`	`getBase()` Returns the required base HTML tag used to surround the toolbar.
`java.lang.String`	`getCloneAcl()` Returns the acl used to control access to the clone action button.
`java.lang.String`	`getCloneType()` Returns the clone type to be acted upon.
`java.lang.String`	`getCloneUrl()` Returns the url pointed by the clone action button.
`java.lang.String`	`getCreationAcl()` Returns the acl used to control access to the creation action button.
`java.lang.String`	`getCreationType()` Returns the creation type to be acted upon.
`java.lang.String`	`getCreationUrl()` Returns the url pointed by the creation action button.
`java.lang.String`	`getDeletionAcl()` Returns the acl used to control access to the deletion action button.
`java.lang.String`	`getDeletionType()` Returns the deletion type to be acted upon.
`java.lang.String`	`getDeletionUrl()` Returns the url pointed by the deletion action button.
`java.lang.String`	`getHelpUrl()` Returns the help url which is used to link to the help pages.
`java.lang.String`	`getIcon()` Getter for the icon id
`java.lang.String`	`getIconAlt()`
`java.lang.String`	`getImg()` Returns the image location to be displayed.
`java.lang.String`	`getImgAlt()`
`java.lang.String`	`getMiscAcl()` Returns the acl used to control access to the miscellaneous link.
`java.lang.String`	`getMiscAlt()` Returns the alternate text for the miscellaneous link.
`java.lang.String`	`getMiscIcon()` Getter for the icon id
`java.lang.String`	`getMiscImg()` Returns the url for the misc image file.
`java.lang.String`	`getMiscText()` Returns the text for the miscellaneous link.
`java.lang.String`	`getMiscUrl()` Returns the url pointed by the miscellaneous link.
`java.lang.String`	`getUploadAcl()`
`java.lang.String`	`getUploadType()`
`java.lang.String`	`getUploadUrl()`
`void`	`release()`
`void`	`setAclMixins(java.lang.String mixins)` Sets the Acl classnames to be mixed in.
`void`	`setBase(java.lang.String b)` Sets the required base HTML tag used to surround the toolbar.
`void`	`setCloneAcl(java.lang.String cloneacl)` Sets the acl used to control access to the clone action button.
`void`	`setCloneType(java.lang.String clonetype)` Sets the clone type to be acted upon.
`void`	`setCloneUrl(java.lang.String cloneurl)` Sets the url pointed by the clone action button.
`void`	`setCreationAcl(java.lang.String createacl)` Sets the acl used to control access to the creation action button.
`void`	`setCreationType(java.lang.String createtype)` Sets the creation type to be acted upon.
`void`	`setCreationUrl(java.lang.String createurl)` Sets the url pointed by the creation action button.
`void`	`setDeletionAcl(java.lang.String delacl)` Sets the acl used to control access to the deletion action button.
`void`	`setDeletionType(java.lang.String deltype)` Sets the deletion type to be acted upon.
`void`	`setDeletionUrl(java.lang.String delurl)` Sets the url pointed by the deletion action button.
`void`	`setHelpUrl(java.lang.String helpurl)` Sets the help url which is used to link to the help pages.
`void`	`setIcon(java.lang.String iconId)` Sets the icon (css class name) which is displayed.
`void`	`setIconAlt(java.lang.String iconAltIn)`
`void`	`setImg(java.lang.String imgurl)` Sets the image location which is displayed.
`void`	`setImgAlt(java.lang.String imgAltIn)`
`void`	`setMiscAcl(java.lang.String miscacl)` Sets the acl used to control access to the miscellaneous link.
`void`	`setMiscAlt(java.lang.String alt)` Sets the alternate text for the miscellaneous link.
`void`	`setMiscIcon(java.lang.String iconId)` Sets the misc icon (css class name) which is displayed.
`void`	`setMiscImg(java.lang.String miscimg)` Sets the image used for the misc link.
`void`	`setMiscText(java.lang.String text)` Sets the text for the miscellaneous link.
`void`	`setMiscUrl(java.lang.String miscurl)` Sets the url pointed by the miscellaneous link.
`void`	`setUploadAcl(java.lang.String acl)`
`void`	`setUploadType(java.lang.String type)`
`void`	`setUploadUrl(java.lang.String url)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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

- Constructor Detail
  - ToolbarTag
```
public ToolbarTag()
```
    Constructor for tag.
- Method Detail
  - setBase
```
public void setBase(java.lang.String b)
```
    Sets the required base HTML tag used to surround the toolbar.
    
    Parameters:
    
    b - valid html tag.
  - getBase
```
public java.lang.String getBase()
```
    Returns the required base HTML tag used to surround the toolbar.
    
    Returns:
    
    the required base HTML tag used to surround the toolbar.
  - setHelpUrl
```
public void setHelpUrl(java.lang.String helpurl)
```
    Sets the help url which is used to link to the help pages.
    
    Parameters:
    
    helpurl - the help url which is used to link to the help pages.
  - getHelpUrl
```
public java.lang.String getHelpUrl()
```
    Returns the help url which is used to link to the help pages.
    
    Returns:
    
    the help url which is used to link to the help pages.
  - setAclMixins
```
public void setAclMixins(java.lang.String mixins)
```
    Sets the Acl classnames to be mixed in. The mixins are applied in addition to the other acls.
    
    Parameters:
    
    mixins - A comma separated list of Acl classnames.
    
    See Also:
    
    getCreationAcl(), getDeletionAcl(), getMiscAcl()
  - getAclMixins
```
public java.lang.String getAclMixins()
```
    Returns:
    
    a comma separated list of Acl classnames to be mixed in.
    
    See Also:
    
    getCreationAcl(), getDeletionAcl(), getMiscAcl()
  - setIcon
```
public void setIcon(java.lang.String iconId)
```
    Sets the icon (css class name) which is displayed.
    
    Parameters:
    
    iconId - Icon's id (usually the css class)
  - getIcon
```
public java.lang.String getIcon()
```
    Getter for the icon id
    
    Returns:
    
    the icon id to be displayed.
  - getIconAlt
```
public java.lang.String getIconAlt()
```
    Returns:
    
    Returns the localization key that will resolve to the alt text of the icon.
  - setIconAlt
```
public void setIconAlt(java.lang.String iconAltIn)
```
    Parameters:
    
    iconAltIn - Sets the localization key that will resolve to the alt text of the icon
  - setImg
```
public void setImg(java.lang.String imgurl)
```
    Sets the image location which is displayed.
    
    Parameters:
    
    imgurl - the location of the image.
  - getImg
```
public java.lang.String getImg()
```
    Returns the image location to be displayed.
    
    Returns:
    
    the image location to be displayed.
  - getImgAlt
```
public java.lang.String getImgAlt()
```
    Returns:
    
    Returns the localization key that will resolve to the alt text of the img.
  - setImgAlt
```
public void setImgAlt(java.lang.String imgAltIn)
```
    Parameters:
    
    imgAltIn - Sets the localization key that will resolve to the alt text of the img
  - setMiscImg
```
public void setMiscImg(java.lang.String miscimg)
```
    Sets the image used for the misc link.
    
    Parameters:
    
    miscimg - URL to image file.
  - getMiscImg
```
public java.lang.String getMiscImg()
```
    Returns the url for the misc image file.
    
    Returns:
    
    the url for the misc image file.
  - setMiscIcon
```
public void setMiscIcon(java.lang.String iconId)
```
    Sets the misc icon (css class name) which is displayed.
    
    Parameters:
    
    iconId - Misc Icon's id (usually the css class)
  - getMiscIcon
```
public java.lang.String getMiscIcon()
```
    Getter for the icon id
    
    Returns:
    
    the icon id to be displayed.
  - setDeletionType
```
public void setDeletionType(java.lang.String deltype)
```
    Sets the deletion type to be acted upon.
    
    Parameters:
    
    deltype - the deletion type to be acted upon.
  - getDeletionType
```
public java.lang.String getDeletionType()
```
    Returns the deletion type to be acted upon.
    
    Returns:
    
    the deletion type to be acted upon.
  - setDeletionAcl
```
public void setDeletionAcl(java.lang.String delacl)
```
    Sets the acl used to control access to the deletion action button.
    
    Parameters:
    
    delacl - the acl used to control access to the deletion action button.
  - getDeletionAcl
```
public java.lang.String getDeletionAcl()
```
    Returns the acl used to control access to the deletion action button.
    
    Returns:
    
    the acl used to control access to the deletion action button.
  - setDeletionUrl
```
public void setDeletionUrl(java.lang.String delurl)
```
    Sets the url pointed by the deletion action button.
    
    Parameters:
    
    delurl - the url pointed by the deletion action button.
  - getDeletionUrl
```
public java.lang.String getDeletionUrl()
```
    Returns the url pointed by the deletion action button.
    
    Returns:
    
    the url pointed by the deletion action button.
  - setCreationType
```
public void setCreationType(java.lang.String createtype)
```
    Sets the creation type to be acted upon.
    
    Parameters:
    
    createtype - the creation type to be acted upon.
  - getCreationType
```
public java.lang.String getCreationType()
```
    Returns the creation type to be acted upon.
    
    Returns:
    
    the creation type to be acted upon.
  - setCreationAcl
```
public void setCreationAcl(java.lang.String createacl)
```
    Sets the acl used to control access to the creation action button.
    
    Parameters:
    
    createacl - the acl used to control access to the creation action button.
  - getCreationAcl
```
public java.lang.String getCreationAcl()
```
    Returns the acl used to control access to the creation action button.
    
    Returns:
    
    the acl used to control access to the creation action button.
  - setCreationUrl
```
public void setCreationUrl(java.lang.String createurl)
```
    Sets the url pointed by the creation action button.
    
    Parameters:
    
    createurl - the url pointed by the creation action button.
  - getCreationUrl
```
public java.lang.String getCreationUrl()
```
    Returns the url pointed by the creation action button.
    
    Returns:
    
    the url pointed by the creation action button.
  - setCloneType
```
public void setCloneType(java.lang.String clonetype)
```
    Sets the clone type to be acted upon.
    
    Parameters:
    
    clonetype - the creation type to be acted upon.
  - getCloneType
```
public java.lang.String getCloneType()
```
    Returns the clone type to be acted upon.
    
    Returns:
    
    the clone type to be acted upon.
  - setCloneAcl
```
public void setCloneAcl(java.lang.String cloneacl)
```
    Sets the acl used to control access to the clone action button.
    
    Parameters:
    
    cloneacl - the acl used to control access to the clone action button.
  - getCloneAcl
```
public java.lang.String getCloneAcl()
```
    Returns the acl used to control access to the clone action button.
    
    Returns:
    
    the acl used to control access to the clone action button.
  - setCloneUrl
```
public void setCloneUrl(java.lang.String cloneurl)
```
    Sets the url pointed by the clone action button.
    
    Parameters:
    
    cloneurl - the url pointed by the clone action button.
  - getCloneUrl
```
public java.lang.String getCloneUrl()
```
    Returns the url pointed by the clone action button.
    
    Returns:
    
    the url pointed by the clone action button.
  - setMiscAcl
```
public void setMiscAcl(java.lang.String miscacl)
```
    Sets the acl used to control access to the miscellaneous link.
    
    Parameters:
    
    miscacl - the acl used to control access to the miscellaneous link.
  - getMiscAcl
```
public java.lang.String getMiscAcl()
```
    Returns the acl used to control access to the miscellaneous link.
    
    Returns:
    
    the acl used to control access to the miscellaneous link.
  - setMiscUrl
```
public void setMiscUrl(java.lang.String miscurl)
```
    Sets the url pointed by the miscellaneous link.
    
    Parameters:
    
    miscurl - url for the miscellaneous link.
  - getMiscUrl
```
public java.lang.String getMiscUrl()
```
    Returns the url pointed by the miscellaneous link.
    
    Returns:
    
    the url pointed by the miscellaneous link.
  - setMiscAlt
```
public void setMiscAlt(java.lang.String alt)
```
    Sets the alternate text for the miscellaneous link.
    
    Parameters:
    
    alt - alternate text for the miscellaneous link.
  - getMiscAlt
```
public java.lang.String getMiscAlt()
```
    Returns the alternate text for the miscellaneous link.
    
    Returns:
    
    the alternate text for the miscellaneous link.
  - setMiscText
```
public void setMiscText(java.lang.String text)
```
    Sets the text for the miscellaneous link.
    
    Parameters:
    
    text - text for the miscellaneous link.
  - getMiscText
```
public java.lang.String getMiscText()
```
    Returns the text for the miscellaneous link.
    
    Returns:
    
    the text for the miscellaneous link.
  - 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.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException - JSP exception
  - 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.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - release
```
public void release()
```
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class javax.servlet.jsp.tagext.TagSupport
  - getUploadUrl
```
public java.lang.String getUploadUrl()
```
    Returns:
    
    the uploadUrl
  - setUploadUrl
```
public void setUploadUrl(java.lang.String url)
```
    Parameters:
    
    url - the uploadUrl to set
  - getUploadAcl
```
public java.lang.String getUploadAcl()
```
    Returns:
    
    the uploadAcl
  - setUploadAcl
```
public void setUploadAcl(java.lang.String acl)
```
    Parameters:
    
    acl - the uploadAcl to set
  - getUploadType
```
public java.lang.String getUploadType()
```
    Returns:
    
    the uploadType
  - setUploadType
```
public void setUploadType(java.lang.String type)
```
    Parameters:
    
    type - the uploadType to set

Class ToolbarTag

Field Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ToolbarTag

Method Detail

setBase

getBase

setHelpUrl

getHelpUrl

setAclMixins

getAclMixins

setIcon

getIcon

getIconAlt

setIconAlt

setImg

getImg

getImgAlt

setImgAlt

setMiscImg

getMiscImg

setMiscIcon

getMiscIcon

setDeletionType

getDeletionType

setDeletionAcl

getDeletionAcl

setDeletionUrl

getDeletionUrl

setCreationType

getCreationType

setCreationAcl

getCreationAcl

setCreationUrl

getCreationUrl

setCloneType

getCloneType

setCloneAcl

getCloneAcl

setCloneUrl

getCloneUrl

setMiscAcl

getMiscAcl

setMiscUrl

getMiscUrl

setMiscAlt

getMiscAlt

setMiscText

getMiscText

doStartTag

doEndTag

release

getUploadUrl

setUploadUrl

getUploadAcl

setUploadAcl

getUploadType

setUploadType