com.aspose.slides
Class HyperlinkEx

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

public class HyperlinkEx
extends java.lang.Object

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

HyperlinkEx

public HyperlinkEx(java.lang.String url)

Creates an instance of a hyperlink.

Parameters:
url - Hyperlink URL.

HyperlinkEx

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.

Parameters:
slide - Target slide.

HyperlinkEx

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.

Parameters:
source - Source hyperlink
targetFrame - Target frame
tooltip - Tooltip text
history -
stopSoundsOnClick -
highlightClick -
Method Detail

getNoAction

public static HyperlinkEx getNoAction()

Returns a special "do nothing" hyperlink. Readonly HyperlinkEx.


getMedia

public static HyperlinkEx getMedia()

Returns a special "play mediafile" hyperlink. Used in AudioFrameEx and VideoFrameEx. Readonly HyperlinkEx.


getNextSlide

public static HyperlinkEx getNextSlide()

Returns a hyperlink to the next slide. Readonly HyperlinkEx.


getPreviousSlide

public static HyperlinkEx getPreviousSlide()

Returns a hyperlink to the previous slide. Readonly HyperlinkEx.


getFirstSlide

public static HyperlinkEx getFirstSlide()

Returns a hyperlink to the first slide of the presentation. Readonly HyperlinkEx.


getLastSlide

public static HyperlinkEx getLastSlide()

Returns a hyperlink to the last slide of the presentation. Readonly HyperlinkEx.


getLastVievedSlide

public static HyperlinkEx getLastVievedSlide()

Returns a hyperlink to the last viewed slide. Readonly HyperlinkEx.


getEndShow

public static HyperlinkEx getEndShow()

Returns a hyperlink which ends the show. Readonly HyperlinkEx.


getExternalUrl

public java.lang.String getExternalUrl()

Returns the external URL


getActionType

public int getActionType()

Returns type of HyperLinkEx's action. Readonly HyperlinkActionTypeEx.


getTargetSlide

public SlideEx getTargetSlide()

If the HyperlinkEx targets specific slide returns this slide. Readonly SlideEx.


getTargetFrame

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.


getTooltip

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.


getHistory

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.


getHighlightClick

public boolean getHighlightClick()

Determines whether the hyperlink should be highlighted on click. Read-only bool.


getStopSoundOnClick

public boolean getStopSoundOnClick()

Determines whether the sound should be stopped on hyperlink click. Read-only bool.


getEndSounds

@Deprecated
public boolean getEndSounds()
Deprecated. 

Determines whether the sound should be stopped on hyperlink click. Read-only bool.


equals

public boolean equals(java.lang.Object obj)

Determines whether the two HyperlinkEx instances are equal.

Overrides:
equals in class java.lang.Object
Parameters:
obj - The HyperlinkEx to compare with the current HyperlinkEx.
Returns:
<b>true</b> if the specified HyperlinkEx is equal to the current HyperlinkEx; otherwise, <b>false</b>.

equals

public boolean equals(HyperlinkEx hlink)

Determines whether the two HyperlinkEx instances are equal.

Parameters:
hlink - The HyperlinkEx to compare with the current HyperlinkEx.
Returns:
<b>true</b> if the specified HyperlinkEx is equal to the current HyperlinkEx; otherwise, <b>false</b>.

op_Equality

public static boolean op_Equality(HyperlinkEx hlink1,
                                  HyperlinkEx hlink2)

Tests two hyperlinks for equality.

Parameters:
hlink1 - First hyperlink to be tested.
hlink2 - Second hyperlink to be tested.
Returns:
<b>True</b> if hyperlinks are equal.

op_Inequality

public static boolean op_Inequality(HyperlinkEx hlink1,
                                    HyperlinkEx hlink2)

Tests two hyperlinks for inequality.

Parameters:
hlink1 - First hyperlink to be tested.
hlink2 - Second hyperlink to be tested.
Returns:
<b>False</b> if hyperlinks are equal.

hashCode

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.

Overrides:
hashCode in class java.lang.Object
Returns:
Hash code for an URL.