java.lang.Object
org.apache.maven.doxia.site.decoration.Banner
All Implemented Interfaces:
Serializable, Cloneable

public class Banner extends Object implements Serializable, Cloneable
Banner logo on the masthead of the site.
Version:
$Revision$ $Date$
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    The alt description for the banner image.
    private String
    The border to use for the banner image.
    private String
    The height to use for the banner image.
    private String
    The href of a link to be used for the banner image.
    private String
    The name of the banner.
    private String
    The source location of an image for the banner.
    private String
    The title for the banner image.
    private String
    The width to use for the banner image.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Method clone.
    boolean
    equals(Object other)
    Method equals.
    Get the alt description for the banner image.
    Get the border to use for the banner image.
    Get the height to use for the banner image.
    Get the href of a link to be used for the banner image.
    Get the name of the banner.
    Get the source location of an image for the banner.
    Get the title for the banner image.
    Get the width to use for the banner image.
    int
    Method hashCode.
    void
    Set the alt description for the banner image.
    void
    setBorder(String border)
    Set the border to use for the banner image.
    void
    setHeight(String height)
    Set the height to use for the banner image.
    void
    Set the href of a link to be used for the banner image.
    void
    Set the name of the banner.
    void
    Set the source location of an image for the banner.
    void
    Set the title for the banner image.
    void
    Set the width to use for the banner image.
    Method toString.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • name

      private String name
      The name of the banner.
    • src

      private String src
      The source location of an image for the banner.
    • alt

      private String alt
      The alt description for the banner image.
    • href

      private String href
      The href of a link to be used for the banner image.
    • border

      private String border
      The border to use for the banner image.
    • width

      private String width
      The width to use for the banner image.
    • height

      private String height
      The height to use for the banner image.
    • title

      private String title
      The title for the banner image.
  • Constructor Details

    • Banner

      public Banner()
  • Method Details

    • clone

      public Banner clone()
      Method clone.
      Overrides:
      clone in class Object
      Returns:
      Banner
    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean
    • getAlt

      public String getAlt()
      Get the alt description for the banner image.
      Returns:
      String
    • getBorder

      public String getBorder()
      Get the border to use for the banner image.
      Returns:
      String
    • getHeight

      public String getHeight()
      Get the height to use for the banner image.
      Returns:
      String
    • getHref

      public String getHref()
      Get the href of a link to be used for the banner image.
      Returns:
      String
    • getName

      public String getName()
      Get the name of the banner.
      Returns:
      String
    • getSrc

      public String getSrc()
      Get the source location of an image for the banner.
      Returns:
      String
    • getTitle

      public String getTitle()
      Get the title for the banner image.
      Returns:
      String
    • getWidth

      public String getWidth()
      Get the width to use for the banner image.
      Returns:
      String
    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int
    • setAlt

      public void setAlt(String alt)
      Set the alt description for the banner image.
      Parameters:
      alt - a alt object.
    • setBorder

      public void setBorder(String border)
      Set the border to use for the banner image.
      Parameters:
      border - a border object.
    • setHeight

      public void setHeight(String height)
      Set the height to use for the banner image.
      Parameters:
      height - a height object.
    • setHref

      public void setHref(String href)
      Set the href of a link to be used for the banner image.
      Parameters:
      href - a href object.
    • setName

      public void setName(String name)
      Set the name of the banner.
      Parameters:
      name - a name object.
    • setSrc

      public void setSrc(String src)
      Set the source location of an image for the banner.
      Parameters:
      src - a src object.
    • setTitle

      public void setTitle(String title)
      Set the title for the banner image.
      Parameters:
      title - a title object.
    • setWidth

      public void setWidth(String width)
      Set the width to use for the banner image.
      Parameters:
      width - a width object.
    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String