com.aspose.slides
Class Hyperlink

java.lang.Object
  extended by com.aspose.slides.Hyperlink
All Implemented Interfaces:
IHyperlink

public class Hyperlink
extends java.lang.Object
implements IHyperlink

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

Hyperlink

public Hyperlink(java.lang.String url)

Creates an instance of a hyperlink.

Parameters:
url - Hyperlink URL.

Hyperlink

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.

Parameters:
slide - Target slide.

Hyperlink

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.

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

getNoAction

public static Hyperlink getNoAction()

Returns a special "do nothing" hyperlink. Read-only Hyperlink.


getMedia

public static Hyperlink getMedia()

Returns a special "play mediafile" hyperlink. Used in AudioFrame and VideoFrame. Read-only Hyperlink.


getNextSlide

public static Hyperlink getNextSlide()

Returns a hyperlink to the next slide. Read-only Hyperlink.


getPreviousSlide

public static Hyperlink getPreviousSlide()

Returns a hyperlink to the previous slide. Read-only Hyperlink.


getFirstSlide

public static Hyperlink getFirstSlide()

Returns a hyperlink to the first slide of the presentation. Read-only Hyperlink.


getLastSlide

public static Hyperlink getLastSlide()

Returns a hyperlink to the last slide of the presentation. Read-only Hyperlink.


getLastVievedSlide

public static Hyperlink getLastVievedSlide()

Returns a hyperlink to the last viewed slide. Read-only Hyperlink.


getEndShow

public static Hyperlink getEndShow()

Returns a hyperlink which ends the show. Read-only Hyperlink.


getExternalUrl

public java.lang.String getExternalUrl()

Specifies the external URL. Read-only String.

Specified by:
getExternalUrl in interface IHyperlink

getActionType

public int getActionType()

Returns type of HyperLinkEx's action. Read-only HyperlinkActionType.

Specified by:
getActionType in interface IHyperlink

getTargetSlide

public ISlide getTargetSlide()

If the Hyperlink targets specific slide returns this slide. Read-only ISlide.

Specified by:
getTargetSlide in interface IHyperlink

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.

Specified by:
getTargetFrame in interface IHyperlink

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.

Specified by:
getTooltip in interface IHyperlink

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 boolean.

Specified by:
getHistory in interface IHyperlink

getHighlightClick

public boolean getHighlightClick()

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

Specified by:
getHighlightClick in interface IHyperlink

getStopSoundOnClick

public boolean getStopSoundOnClick()

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

Specified by:
getStopSoundOnClick in interface IHyperlink

equals

public boolean equals(java.lang.Object obj)

Determines whether the two Hyperlink instances are equal.

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

equals

public boolean equals(IHyperlink hlink)

Determines whether the two Hyperlink instances are equal.

Specified by:
equals in interface IHyperlink
Parameters:
hlink - The Hyperlink to compare with the current Hyperlink.
Returns:
<b>true</b> if the specified Hyperlink is equal to the current Hyperlink; otherwise, <b>false</b>.

op_Equality

public static boolean op_Equality(Hyperlink hlink1,
                                  Hyperlink 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(Hyperlink hlink1,
                                    Hyperlink 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.


Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.