Class LinkItem
java.lang.Object
org.apache.maven.doxia.site.decoration.LinkItem
- All Implemented Interfaces:
Serializable,Cloneable
A link in the navigation.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringThe alt to use for the image.private StringThe border to use for the image.private StringThe height to use for the image.private StringThe href to use for the link.private StringThe source location of an image.private StringThe name to display for the link.private StringWhere to place the image regarding the displayed name (left or right).private StringWhere the new document will be displayed when the user follows a link, i.e.private StringThe title to use for the image.private StringThe width to use for the image. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Method clone.booleanMethod equals.getAlt()Get the alt to use for the image.Get the border to use for the image.Get the height to use for the image.getHref()Get the href to use for the link.getImg()Get the source location of an image.getName()Get the name to display for the link.Get where to place the image regarding the displayed name (left or right).Get where the new document will be displayed when the user follows a link, i.e.getTitle()Get the title to use for the image.getWidth()Get the width to use for the image.inthashCode()Method hashCode.voidSet the alt to use for the image.voidSet the border to use for the image.voidSet the height to use for the image.voidSet the href to use for the link.voidSet the source location of an image.voidSet the name to display for the link.voidsetPosition(String position) Set where to place the image regarding the displayed name (left or right).voidSet where the new document will be displayed when the user follows a link, i.e.voidSet the title to use for the image.voidSet the width to use for the image.toString()Method toString.
-
Field Details
-
name
The name to display for the link. -
href
The href to use for the link. -
img
The source location of an image. -
position
Where to place the image regarding the displayed name (left or right). -
alt
The alt to use for the image. -
border
The border to use for the image. -
width
The width to use for the image. -
height
The height to use for the image. -
target
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. -
title
The title to use for the image.
-
-
Constructor Details
-
LinkItem
public LinkItem()
-
-
Method Details
-
clone
Method clone. -
equals
Method equals. -
getAlt
Get the alt to use for the image.- Returns:
- String
-
getBorder
Get the border to use for the image.- Returns:
- String
-
getHeight
Get the height to use for the image.- Returns:
- String
-
getHref
Get the href to use for the link.- Returns:
- String
-
getImg
Get the source location of an image.- Returns:
- String
-
getName
Get the name to display for the link.- Returns:
- String
-
getPosition
Get where to place the image regarding the displayed name (left or right).- Returns:
- String
-
getTarget
Get where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.- Returns:
- String
-
getTitle
Get the title to use for the image.- Returns:
- String
-
getWidth
Get the width to use for the image.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
setAlt
Set the alt to use for the image.- Parameters:
alt- a alt object.
-
setBorder
Set the border to use for the image.- Parameters:
border- a border object.
-
setHeight
Set the height to use for the image.- Parameters:
height- a height object.
-
setHref
Set the href to use for the link.- Parameters:
href- a href object.
-
setImg
Set the source location of an image.- Parameters:
img- a img object.
-
setName
Set the name to display for the link.- Parameters:
name- a name object.
-
setPosition
Set where to place the image regarding the displayed name (left or right).- Parameters:
position- a position object.
-
setTarget
Set where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.- Parameters:
target- a target object.
-
setTitle
Set the title to use for the image.- Parameters:
title- a title object.
-
setWidth
Set the width to use for the image.- Parameters:
width- a width object.
-
toString
Method toString.
-