Package com.independentsoft.office.odf
Class Hyperlink
java.lang.Object
com.independentsoft.office.odf.Hyperlink
- All Implemented Interfaces:
IContentElement,IParagraphContent
Represents a hyperlink.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(Annotation annotation)Adds an Annotation object to the content.voidadd(AttributedText attributedText)Adds an AttributedText object to the content.voidAdds a Bookmark object to the content.voidadd(BookmarkEnd bookmarkEnd)Adds a BookmarkEnd object to the content.voidadd(BookmarkStart bookmarkStart)Adds a BookmarkStart object to the content.voidAdds a Change object to the content.voidAdds a ChangeEnd object to the content.voidadd(ChangeStart changeStart)Adds a ChangeStart object to the content.voidAdds a Shape object to the content.voidAdds a Field object to the content.voidAdds a Hyperlink object to the content.voidadd(IParagraphContent paragraphContent)Adds an IParagraphContent object to the content.voidAdds a Note object to the content.voidadd(PointReference pointReference)Adds a PointReference object to the content.voidadd(RangeReference rangeReference)Adds a RangeReference object to the content.voidAdds a Ruby object to the content.voidAdds a Text object to the content.voidAdds a String object to the content.voidAdds a single line break to the content.voidaddSpace()Adds a single space to the content.voidaddSpace(int spaceCount)Adds a single space to the content.voidaddTab()Adds a single tab to the content.clone()Creates a new object that is a deep copy of the current instance.Gets the value onRequest or onLoad for the objects.Contains the hyperlink content.Returns all content elements.Contains the attachment of an event listener to a drawing shape.Gets an URI of a document containing a source table.getName()Gets the name.Returns the parent content element.getShow()Gets the text style for an unvisited hyperlink.getStyle()Gets the text style for an unvisited hyperlink.Gets the name of a target frame.getTitle()Gets a short accessible description.Gets the style for a hyperlink that has been visited.voidsetActuate(String actuate)Sets the value onRequest or onLoad for the objects.voidsetLocation(String location)Sets an URI of a document containing a source table.voidSets the name.voidsetParent(IContentElement parent)Sets the parent content element.voidSets the text style for an unvisited hyperlink.voidSets the text style for an unvisited hyperlink.voidsetTargetFrame(String targetFrame)Sets the name of a target frame.voidSets a short accessible description.voidsetVisitedStyle(String visitedStyle)Sets the style for a hyperlink that has been visited.toString()Converts the value of the current Hyperlink object to its equivalent string representation.
-
Constructor Details
-
Hyperlink
public Hyperlink()Initializes a new instance of the Hyperlink class.
-
-
Method Details
-
addSpace
public void addSpace()Adds a single space to the content. -
addSpace
public void addSpace(int spaceCount)Adds a single space to the content.- Parameters:
spaceCount- the space count
-
addTab
public void addTab()Adds a single tab to the content. -
addLineBreak
public void addLineBreak()Adds a single line break to the content. -
add
Adds a String object to the content.- Parameters:
text- the text
-
add
Adds a Text object to the content.- Parameters:
text- the text
-
add
Adds an Annotation object to the content.- Parameters:
annotation- the annotation
-
add
Adds an AttributedText object to the content.- Parameters:
attributedText- the attributed text
-
add
Adds a Hyperlink object to the content.- Parameters:
hyperlink- the hyperlink
-
add
Adds a Field object to the content.- Parameters:
field- the field
-
add
Adds a Bookmark object to the content.- Parameters:
bookmark- the bookmark
-
add
Adds a BookmarkStart object to the content.- Parameters:
bookmarkStart- the bookmark start
-
add
Adds a BookmarkEnd object to the content.- Parameters:
bookmarkEnd- the bookmark end
-
add
Adds a Change object to the content.- Parameters:
change- the change
-
add
Adds a ChangeEnd object to the content.- Parameters:
changeEnd- the change end
-
add
Adds a ChangeStart object to the content.- Parameters:
changeStart- the change start
-
add
Adds a Shape object to the content.- Parameters:
shape- the shape
-
add
Adds a Note object to the content.- Parameters:
note- the note
-
add
Adds a Ruby object to the content.- Parameters:
ruby- the ruby
-
add
Adds a PointReference object to the content.- Parameters:
pointReference- the point reference
-
add
Adds a RangeReference object to the content.- Parameters:
rangeReference- the range reference
-
add
Adds an IParagraphContent object to the content.- Parameters:
paragraphContent- the paragraph content
-
getContentElements
Returns all content elements.- Specified by:
getContentElementsin interfaceIContentElement- Returns:
- A collection of content elements.
-
getParent
Returns the parent content element.- Specified by:
getParentin interfaceIContentElement- Returns:
- the parent
-
setParent
Sets the parent content element.- Specified by:
setParentin interfaceIContentElement- Parameters:
parent- the new parent
-
clone
Creates a new object that is a deep copy of the current instance.- Specified by:
clonein interfaceIContentElement- Specified by:
clonein interfaceIParagraphContent- Overrides:
clonein classObject- Returns:
- A new object that is a copy of this instance.
-
toString
Converts the value of the current Hyperlink object to its equivalent string representation. -
getContent
Contains the hyperlink content.- Returns:
- the content
-
getEventListeners
Contains the attachment of an event listener to a drawing shape.- Returns:
- the event listeners
-
getName
Gets the name. The name can serve as a target for other hyperlinks. The name does not have to be unique.- Returns:
- the name
-
setName
Sets the name. The name can serve as a target for other hyperlinks. The name does not have to be unique.- Parameters:
name- the new name
-
getTitle
Gets a short accessible description.- Returns:
- the title
-
setTitle
Sets a short accessible description.- Parameters:
title- the new title
-
getActuate
Gets the value onRequest or onLoad for the objects.- Returns:
- the actuate
-
setActuate
Sets the value onRequest or onLoad for the objects.- Parameters:
actuate- the new actuate
-
getLocation
Gets an URI of a document containing a source table.- Returns:
- the location
-
setLocation
Sets an URI of a document containing a source table.- Parameters:
location- the new location
-
getShow
Gets the text style for an unvisited hyperlink.- Returns:
- the show
-
setShow
Sets the text style for an unvisited hyperlink.- Parameters:
show- the new show
-
getTargetFrame
Gets the name of a target frame.- Returns:
- the target frame
-
setTargetFrame
Sets the name of a target frame.- Parameters:
targetFrame- the new target frame
-
getStyle
Gets the text style for an unvisited hyperlink.- Returns:
- the style
-
setStyle
Sets the text style for an unvisited hyperlink.- Parameters:
style- the new style
-
getVisitedStyle
Gets the style for a hyperlink that has been visited.- Returns:
- the visited style
-
setVisitedStyle
Sets the style for a hyperlink that has been visited.- Parameters:
visitedStyle- the new visited style
-