Package org.apache.poi.hslf.record
Class ExHyperlink
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordContainer
org.apache.poi.hslf.record.ExHyperlink
This class represents the data of a link in the document.
- Author:
- Nick Burch
-
Field Summary
Fields inherited from class org.apache.poi.hslf.record.RecordContainer
_children -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a new ExHyperlink, with blank fieldsprotectedExHyperlink(byte[] source, int start, int len) Set things up, and find our more interesting children -
Method Summary
Modifier and TypeMethodDescriptionGet the link details (field A)Get the link details (field B)Returns the ExHyperlinkAtom of this linkReturns the hyperlink's user-readable nameReturns the URL of the link.longWe are of type 4055voidsetLinkOptions(int options) voidsetLinkTitle(String title) voidsetLinkURL(String url) Sets the URL of the link TODO: Figure out if we should always set bothvoidwriteOut(OutputStream out) Write the contents of the record back, so it can be written to diskMethods inherited from class org.apache.poi.hslf.record.RecordContainer
addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, moveChildBefore, moveChildrenAfter, moveChildrenBefore, removeChild, setChildRecord, writeOutMethods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Constructor Details
-
ExHyperlink
protected ExHyperlink(byte[] source, int start, int len) Set things up, and find our more interesting children -
ExHyperlink
public ExHyperlink()Create a new ExHyperlink, with blank fields
-
-
Method Details
-
getExHyperlinkAtom
Returns the ExHyperlinkAtom of this link -
getLinkURL
Returns the URL of the link.- Returns:
- the URL of the link
-
getLinkTitle
Returns the hyperlink's user-readable name- Returns:
- the hyperlink's user-readable name
-
setLinkURL
Sets the URL of the link TODO: Figure out if we should always set both -
setLinkOptions
public void setLinkOptions(int options) -
setLinkTitle
-
_getDetailsA
Get the link details (field A) -
_getDetailsB
Get the link details (field B) -
getRecordType
public long getRecordType()We are of type 4055- Specified by:
getRecordTypein classRecord
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOutin classRecord- Throws:
IOException
-