|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.HyperlinkEx
public class HyperlinkEx
Represents a hyperlink. Immutable.
Constructor Summary | |
---|---|
HyperlinkEx(HyperlinkEx 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. |
|
HyperlinkEx(SlideEx slide)
Creates an instance of a hyperlink which points to specific slide. |
|
HyperlinkEx(java.lang.String url)
Creates an instance of a hyperlink. |
Method Summary | |
---|---|
boolean |
equals(HyperlinkEx hlink)
Determines whether the two HyperlinkEx instances are equal. |
boolean |
equals(java.lang.Object obj)
Determines whether the two HyperlinkEx instances are equal. |
int |
getActionType()
Returns type of HyperLinkEx's action. |
static HyperlinkEx |
getEndShow()
Returns a hyperlink which ends the show. |
boolean |
getEndSounds()
Deprecated. |
java.lang.String |
getExternalUrl()
Returns the external URL |
static HyperlinkEx |
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 HyperlinkEx |
getLastSlide()
Returns a hyperlink to the last slide of the presentation. |
static HyperlinkEx |
getLastVievedSlide()
Returns a hyperlink to the last viewed slide. |
static HyperlinkEx |
getMedia()
Returns a special "play mediafile" hyperlink. |
static HyperlinkEx |
getNextSlide()
Returns a hyperlink to the next slide. |
static HyperlinkEx |
getNoAction()
Returns a special "do nothing" hyperlink. |
static HyperlinkEx |
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. |
SlideEx |
getTargetSlide()
If the HyperlinkEx 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(HyperlinkEx hlink1,
HyperlinkEx hlink2)
Tests two hyperlinks for equality. |
static boolean |
op_Inequality(HyperlinkEx hlink1,
HyperlinkEx hlink2)
Tests two hyperlinks for inequality. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HyperlinkEx(java.lang.String url)
Creates an instance of a hyperlink.
url
- Hyperlink URL.public HyperlinkEx(SlideEx 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 HyperlinkEx(HyperlinkEx 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 HyperlinkEx getNoAction()
Returns a special "do nothing" hyperlink. Readonly HyperlinkEx.
public static HyperlinkEx getMedia()
Returns a special "play mediafile" hyperlink. Used in AudioFrameEx and VideoFrameEx.
Readonly HyperlinkEx
.
public static HyperlinkEx getNextSlide()
Returns a hyperlink to the next slide.
Readonly HyperlinkEx
.
public static HyperlinkEx getPreviousSlide()
Returns a hyperlink to the previous slide.
Readonly HyperlinkEx
.
public static HyperlinkEx getFirstSlide()
Returns a hyperlink to the first slide of the presentation.
Readonly HyperlinkEx
.
public static HyperlinkEx getLastSlide()
Returns a hyperlink to the last slide of the presentation.
Readonly HyperlinkEx
.
public static HyperlinkEx getLastVievedSlide()
Returns a hyperlink to the last viewed slide.
Readonly HyperlinkEx
.
public static HyperlinkEx getEndShow()
Returns a hyperlink which ends the show.
Readonly HyperlinkEx
.
public java.lang.String getExternalUrl()
Returns the external URL
public int getActionType()
Returns type of HyperLinkEx's action.
Readonly HyperlinkActionTypeEx
.
public SlideEx getTargetSlide()
If the HyperlinkEx targets specific slide returns this slide.
Readonly SlideEx
.
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
.
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
.
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
.
public boolean getHighlightClick()
Determines whether the hyperlink should be highlighted on click.
Read-only bool
.
public boolean getStopSoundOnClick()
Determines whether the sound should be stopped on hyperlink click.
Read-only bool
.
@Deprecated public boolean getEndSounds()
Determines whether the sound should be stopped on hyperlink click.
Read-only bool
.
public boolean equals(java.lang.Object obj)
Determines whether the two HyperlinkEx instances are equal.
equals
in class java.lang.Object
obj
- The HyperlinkEx to compare with the current HyperlinkEx.
<b>true</b>
if the specified HyperlinkEx is equal to the current HyperlinkEx; otherwise, <b>false</b>
.public boolean equals(HyperlinkEx hlink)
Determines whether the two HyperlinkEx instances are equal.
hlink
- The HyperlinkEx to compare with the current HyperlinkEx.
<b>true</b>
if the specified HyperlinkEx is equal to the current HyperlinkEx; otherwise, <b>false</b>
.public static boolean op_Equality(HyperlinkEx hlink1, HyperlinkEx 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(HyperlinkEx hlink1, HyperlinkEx 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 |