Class HoverHyperlink
java.lang.Object
com.independentsoft.office.drawing.HoverHyperlink
Represents the hover hyperlink (
a:hlinkHover) of a drawing
element - the action taken when the pointer rests on the shape.-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates a new hover hyperlink.HoverHyperlink(InternalXMLStreamReader reader)Instantiates a new hover hyperlink. -
Method Summary
Modifier and TypeMethodDescriptionclone()Gets the action.booleanChecks if sounds stop when the action starts.Gets the DrawingML extension list (a:extLst).booleanChecks if the hyperlink is highlighted on click.booleanChecks if the target is added to the browsing history (default true).Gets the invalid url.Gets the relationship id kept for an External target.getSound()Gets the sound to play on activation (a:snd).Gets the target frame.Gets the tooltip.voidSets the action.voidsetEndSounds(boolean endSounds)Sets whether sounds stop when the action starts.voidsetExtensionList(ExtensionList extensionList)Sets the DrawingML extension list (a:extLst).voidsetHighlightClick(boolean highlightClick)Sets whether the hyperlink is highlighted on click.voidsetHistory(boolean history)Sets whether the target is added to the browsing history.voidsetInvalidUrl(String invalidUrl)Sets the invalid url.voidSets the sound to play on activation (a:snd).voidsetTargetFrame(String targetFrame)Sets the target frame.voidsetTooltip(String tooltip)Sets the tooltip.toString()To xml.
-
Constructor Details
-
HoverHyperlink
public HoverHyperlink()Instantiates a new hover hyperlink. -
HoverHyperlink
Instantiates a new hover hyperlink.- Parameters:
reader- the reader- Throws:
XMLStreamException- the XML stream exception
-
-
Method Details
-
clone
-
toString
-
toXml
To xml.- Parameters:
declarations- optional xmlns attributes for hosts that do not have the "a" prefix in scope at the element (e.g. wp:docPr precedes a:graphic's declaration)- Returns:
- the string
-
getRelationshipId
Gets the relationship id kept for an External target.- Returns:
- the relationship id
-
getSound
Gets the sound to play on activation (a:snd).- Returns:
- the sound
-
setSound
Sets the sound to play on activation (a:snd).- Parameters:
sound- the new sound
-
getExtensionList
Gets the DrawingML extension list (a:extLst).- Returns:
- the extension list
-
setExtensionList
Sets the DrawingML extension list (a:extLst).- Parameters:
extensionList- the new extension list
-
getAction
Gets the action.- Returns:
- the action
-
setAction
Sets the action.- Parameters:
action- the new action
-
getEndSounds
public boolean getEndSounds()Checks if sounds stop when the action starts.- Returns:
- true, if end sounds
-
setEndSounds
public void setEndSounds(boolean endSounds)Sets whether sounds stop when the action starts.- Parameters:
endSounds- the new end sounds
-
getHighlightClick
public boolean getHighlightClick()Checks if the hyperlink is highlighted on click.- Returns:
- true, if highlight click
-
setHighlightClick
public void setHighlightClick(boolean highlightClick)Sets whether the hyperlink is highlighted on click.- Parameters:
highlightClick- the new highlight click
-
getHistory
public boolean getHistory()Checks if the target is added to the browsing history (default true).- Returns:
- true, if history
-
setHistory
public void setHistory(boolean history)Sets whether the target is added to the browsing history.- Parameters:
history- the new history
-
getInvalidUrl
Gets the invalid url.- Returns:
- the invalid url
-
setInvalidUrl
Sets the invalid url.- Parameters:
invalidUrl- the new invalid url
-
getTargetFrame
Gets the target frame.- Returns:
- the target frame
-
setTargetFrame
Sets the target frame.- Parameters:
targetFrame- the new target frame
-
getTooltip
Gets the tooltip.- Returns:
- the tooltip
-
setTooltip
Sets the tooltip.- Parameters:
tooltip- the new tooltip
-