com.aspose.slides
Class Link

java.lang.Object
  extended by com.aspose.slides.Link

public final class Link
extends java.lang.Object

Represents the hyperlink in a text.


Constructor Summary
protected Link(InteractiveInfoAtom iia, TxInteractiveInfoAtom tiia, Document doc)
           
 
Method Summary
protected  void clearLink()
          Deletes ExHyperlink object from ExObjList.
 int getActionType()
          Returns action type for a link.
 int getBegin()
          Returns the begin of a link in a text.
 int getEnd()
          Returns the end of a link in a text.
 java.lang.String getExternalHyperlink()
          Returns string which is an external hyperlink or null if type of link is not ExternalHyperlink.
protected  InteractiveInfoAtom getInteractiveInfoAtom()
           
 int getInternalHyperlink()
          Returns Id of a slide for internal hyperlink or -1 if type of link is not InternalHyperlink.
 int getJumpType()
          Returns jump type for a link if ActionType is JumpAction.
 void setBegin(int value)
          Sets the begin of a link in a text.
 void setEnd(int value)
          Sets the end of a link in a text.
 void setExternalHyperlink(java.lang.String hyperlink)
          Sets link destination to the custom url and changes action type to HyperlinkAction.
 void setInternalHyperlink(long slideId)
          Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.
 void setInternalHyperlink(Slide slide)
          Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.
 void setJump(int jumpType)
          Sets jump destination and changes action type to JumpAction.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Link

protected Link(InteractiveInfoAtom iia,
               TxInteractiveInfoAtom tiia,
               Document doc)
Method Detail

getInteractiveInfoAtom

protected InteractiveInfoAtom getInteractiveInfoAtom()

getBegin

public int getBegin()
Returns the begin of a link in a text.

Returns:
The begin of a link.

setBegin

public void setBegin(int value)
Sets the begin of a link in a text.

Parameters:
value - new begin of a link.

getEnd

public int getEnd()
Returns the end of a link in a text.

Returns:
The end of a link.

setEnd

public void setEnd(int value)
Sets the end of a link in a text.

Parameters:
value - new end of a link.

getActionType

public int getActionType()
Returns action type for a link.

Returns:
The action type. See LinkActionType.

getJumpType

public int getJumpType()
Returns jump type for a link if ActionType is JumpAction.

Returns:
The jump type. See LinkJumpType.

clearLink

protected void clearLink()
Deletes ExHyperlink object from ExObjList.


setJump

public void setJump(int jumpType)
Sets jump destination and changes action type to JumpAction.

Parameters:
jumpType - new jump type. See LinkJumpType.

getInternalHyperlink

public int getInternalHyperlink()
Returns Id of a slide for internal hyperlink or -1 if type of link is not InternalHyperlink.

Returns:
The slide Id.

getExternalHyperlink

public java.lang.String getExternalHyperlink()
Returns string which is an external hyperlink or null if type of link is not ExternalHyperlink.

Returns:
The external hyperlink.

setInternalHyperlink

public void setInternalHyperlink(long slideId)
                          throws PptPropertyException
Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.

Parameters:
slideId - slide Id.
Throws:
PptPropertyException

setInternalHyperlink

public void setInternalHyperlink(Slide slide)
Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.

Parameters:
slide - slide object.

setExternalHyperlink

public void setExternalHyperlink(java.lang.String hyperlink)
Sets link destination to the custom url and changes action type to HyperlinkAction.

Parameters:
hyperlink - url string.