|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.Hyperlink
public class Hyperlink
Represents a hyperlink. Immutable.
Constructor Summary | |
---|---|
Hyperlink(Hyperlink source,
java.lang.String targetFrame,
java.lang.String tooltip,
boolean history,
boolean stopSoundsOnClick,
boolean highlightClick)
Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties. |
|
Hyperlink(ISlide slide)
Creates an instance of a hyperlink which points to specific slide. |
|
Hyperlink(java.lang.String url)
Creates an instance of a hyperlink. |
Method Summary | |
---|---|
boolean |
equals(IHyperlink hlink)
Determines whether the two Hyperlink instances are equal. |
boolean |
equals(java.lang.Object obj)
Determines whether the two Hyperlink instances are equal. |
int |
getActionType()
Returns type of HyperLinkEx's action. |
static Hyperlink |
getEndShow()
Returns a hyperlink which ends the show. |
java.lang.String |
getExternalUrl()
Specifies the external URL |
static Hyperlink |
getFirstSlide()
Returns a hyperlink to the first slide of the presentation. |
boolean |
getHighlightClick()
Determines whether the hyperlink should be highlighted on click. |
boolean |
getHistory()
Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked. |
static Hyperlink |
getLastSlide()
Returns a hyperlink to the last slide of the presentation. |
static Hyperlink |
getLastVievedSlide()
Returns a hyperlink to the last viewed slide. |
static Hyperlink |
getMedia()
Returns a special "play mediafile" hyperlink. |
static Hyperlink |
getNextSlide()
Returns a hyperlink to the next slide. |
static Hyperlink |
getNoAction()
Returns a special "do nothing" hyperlink. |
static Hyperlink |
getPreviousSlide()
Returns a hyperlink to the previous slide. |
boolean |
getStopSoundOnClick()
Determines whether the sound should be stopped on hyperlink click. |
java.lang.String |
getTargetFrame()
Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. |
ISlide |
getTargetSlide()
If the Hyperlink targets specific slide returns this slide. |
java.lang.String |
getTooltip()
Returns the string which may be surfaced in a user interface as associated with the parent hyperlink. |
int |
hashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
static boolean |
op_Equality(Hyperlink hlink1,
Hyperlink hlink2)
Tests two hyperlinks for equality. |
static boolean |
op_Inequality(Hyperlink hlink1,
Hyperlink hlink2)
Tests two hyperlinks for inequality. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Hyperlink(java.lang.String url)
Creates an instance of a hyperlink.
url
- Hyperlink URL.public Hyperlink(ISlide slide)
Creates an instance of a hyperlink which points to specific slide. Note: created hyperlink should be assigned to some object from the same presentation, otherwise link will be saved as NoAction.
slide
- Target slide.public Hyperlink(Hyperlink source, java.lang.String targetFrame, java.lang.String tooltip, boolean history, boolean stopSoundsOnClick, boolean highlightClick)
Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties.
source
- Source hyperlinktargetFrame
- Target frametooltip
- Tooltip texthistory
- stopSoundsOnClick
- highlightClick
- Method Detail |
---|
public static Hyperlink getNoAction()
Returns a special "do nothing" hyperlink. Readonly Hyperlink.
public static Hyperlink getMedia()
Returns a special "play mediafile" hyperlink. Used in AudioFrame and VideoFrame.
Readonly Hyperlink
.
public static Hyperlink getNextSlide()
Returns a hyperlink to the next slide.
Readonly Hyperlink
.
public static Hyperlink getPreviousSlide()
Returns a hyperlink to the previous slide.
Readonly Hyperlink
.
public static Hyperlink getFirstSlide()
Returns a hyperlink to the first slide of the presentation.
Readonly Hyperlink
.
public static Hyperlink getLastSlide()
Returns a hyperlink to the last slide of the presentation.
Readonly Hyperlink
.
public static Hyperlink getLastVievedSlide()
Returns a hyperlink to the last viewed slide.
Readonly Hyperlink
.
public static Hyperlink getEndShow()
Returns a hyperlink which ends the show.
Readonly Hyperlink
.
public java.lang.String getExternalUrl()
Specifies the external URL
getExternalUrl
in interface IHyperlink
public int getActionType()
Returns type of HyperLinkEx's action.
Readonly HyperlinkActionType
.
getActionType
in interface IHyperlink
public ISlide getTargetSlide()
If the Hyperlink targets specific slide returns this slide.
getTargetSlide
in interface IHyperlink
public java.lang.String getTargetFrame()
Returns the frame within the parent HTML frameset for the target
of the parent hyperlink when one exists.
Read-only string
.
getTargetFrame
in interface IHyperlink
public java.lang.String getTooltip()
Returns the string which may be surfaced in a user interface
as associated with the parent hyperlink.
Read-only string
.
getTooltip
in interface IHyperlink
public boolean getHistory()
Determines whether the target of the parent hyperlink shall be added
to a list of viewed hyperlinks when it is invoked.
Read-only bool
.
getHistory
in interface IHyperlink
public boolean getHighlightClick()
Determines whether the hyperlink should be highlighted on click.
Read-only bool
.
getHighlightClick
in interface IHyperlink
public boolean getStopSoundOnClick()
Determines whether the sound should be stopped on hyperlink click.
Read-only bool
.
getStopSoundOnClick
in interface IHyperlink
public boolean equals(java.lang.Object obj)
Determines whether the two Hyperlink instances are equal.
equals
in class java.lang.Object
obj
- The Hyperlink to compare with the current Hyperlink.
<b>true</b>
if the specified Hyperlink is equal to the current Hyperlink; otherwise, <b>false</b>
.public boolean equals(IHyperlink hlink)
Determines whether the two Hyperlink instances are equal.
equals
in interface IHyperlink
hlink
- The Hyperlink to compare with the current Hyperlink.
<b>true</b>
if the specified Hyperlink is equal to the current Hyperlink; otherwise, <b>false</b>
.public static boolean op_Equality(Hyperlink hlink1, Hyperlink hlink2)
Tests two hyperlinks for equality.
hlink1
- First hyperlink to be tested.hlink2
- Second hyperlink to be tested.
<b>True</b>
if hyperlinks are equal.public static boolean op_Inequality(Hyperlink hlink1, Hyperlink hlink2)
Tests two hyperlinks for inequality.
hlink1
- First hyperlink to be tested.hlink2
- Second hyperlink to be tested.
<b>False</b>
if hyperlinks are equal.public int hashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
hashCode
in class java.lang.Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |