public interface

WebHyperLinks

com.microstrategy.web.objects.WebHyperLinks

Class Overview

The WebHyperLinks interface represents the collection of WebHyperLink associated with grid report cell or RWD text field.

Summary

Public Methods
abstract WebHyperLink add()
add a Hyperlink to this link collection
abstract void clear()
clear all Hyperlinks in this link collection.
abstract Iterator<WebHyperLink> elements()
Returns an iterator over the Hyperlinks collection
abstract WebHyperLink get(int i)
Returns the i-th hyperlink in this collection
abstract WebHyperLink getDefault()
Returns default HyperLink or null if there is no Hyperlink set as default
abstract boolean getOpenInNewWindow()
Returns true if target URL or report or document shall be displayed in the new window.
abstract void setOpenInNewWindow(boolean b)
Sets/Unsets whether target URL or report or document shall be displayed in the new window.
abstract int size()
Returns the number of Hyeprlinks in link collection.

Public Methods

public abstract WebHyperLink add ()

add a Hyperlink to this link collection

Returns
Throws
WebObjectsException

public abstract void clear ()

clear all Hyperlinks in this link collection.

public abstract Iterator<WebHyperLink> elements ()

Returns an iterator over the Hyperlinks collection

Returns
  • Iterator over the Hyperlinks collection

public abstract WebHyperLink get (int i)

Returns the i-th hyperlink in this collection

Parameters
i the index (starting from 0)
Returns
  • the i-th hyperlink
Throws
IllegalArgumentException thrown if there is no hyperlink at the given index.

public abstract WebHyperLink getDefault ()

Returns default HyperLink or null if there is no Hyperlink set as default

Returns
  • WebHyperLink the default Hyperlink or null if there is no Hyperlink set as default

public abstract boolean getOpenInNewWindow ()

Returns true if target URL or report or document shall be displayed in the new window.

Returns
  • true if target URL or report or document shall be displayed in the new window.

public abstract void setOpenInNewWindow (boolean b)

Sets/Unsets whether target URL or report or document shall be displayed in the new window.

Parameters
b the flag to open a new window if b is true, the target Hyperlink will be opened in a new window if b is false, the target Hyperlink will be opened in current window

public abstract int size ()

Returns the number of Hyeprlinks in link collection.

Returns
  • the number of Hyperlinks in link collection.