org.apache.poi.hslf.record
Class InteractiveInfoAtom

java.lang.Object
  org.apache.poi.hslf.record.Record
      org.apache.poi.hslf.record.RecordAtom
          org.apache.poi.hslf.record.InteractiveInfoAtom

public class InteractiveInfoAtom
extends RecordAtom

Tne atom that holds metadata on Links in the document. (The actual link is held Document.ExObjList.ExHyperlink)

Author:

Nick Burch

Field Summary

Fields inherited from class org.apache.poi.hslf.record.Record

logger

Constructor Summary

protected	InteractiveInfoAtom() Constructs a brand new link related atom record.
protected	InteractiveInfoAtom(byte[] source, int start, int len) Constructs the link related atom record from its source data.

Method Summary

int	_getNumber1() Get the first number - meaning unknown
int	_getNumber3() Get the third number - meaning unknown
int	_getNumber4() Get the fourth number - meaning unknown
protected void	_setNumber1(int val)
protected void	_setNumber3(int val)
protected void	_setNumber4(int val)
int	getNumber() Gets the link number.
long	getRecordType() Gets the record type.
void	setNumber(int number) Sets the link number
void	writeOut(java.io.OutputStream out) Write the contents of the record back, so it can be written to disk

Methods inherited from class org.apache.poi.hslf.record.RecordAtom

getChildRecords, isAnAtom

Methods inherited from class org.apache.poi.hslf.record.Record

buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InteractiveInfoAtom

protected InteractiveInfoAtom()

Constructs a brand new link related atom record.

InteractiveInfoAtom

protected InteractiveInfoAtom(byte[] source,
                              int start,
                              int len)

Constructs the link related atom record from its source data.

Parameters:

source - the source data as a byte array.

start - the start offset into the byte array.

len - the length of the slice in the byte array.

Method Detail

getNumber

public int getNumber()

Gets the link number. You will normally look the ExHyperlink with this number to get the details.

Returns:

the link number

setNumber

public void setNumber(int number)

Sets the link number

Parameters:

number - the link number.

_getNumber1

public int _getNumber1()

Get the first number - meaning unknown

_setNumber1

protected void _setNumber1(int val)

_getNumber3

public int _getNumber3()

Get the third number - meaning unknown

_setNumber3

protected void _setNumber3(int val)

_getNumber4

public int _getNumber4()

Get the fourth number - meaning unknown

_setNumber4

protected void _setNumber4(int val)

getRecordType

public long getRecordType()

Gets the record type.

Specified by:

getRecordType in class Record

Returns:

the record type.

writeOut

public void writeOut(java.io.OutputStream out)
              throws java.io.IOException

Write the contents of the record back, so it can be written to disk

Specified by:

writeOut in class Record

Parameters:

out - the output stream to write to.

Throws:

java.io.IOException - if an error occurs.