TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Class DLinkUtil

java.lang.Object
  extended by org.eclipse.tptp.platform.report.core.internal.DLinkUtil

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DLinkUtil
extends java.lang.Object

Provides utility code and link's method definition for IDLink implementors.

See Also:
IDLink, DLink

Field Summary
static java.lang.String DEFAULT_LINK
          Deprecated. Link property: when the user clicks on this type of link document is moved to target.
static java.lang.String DETACH
          Deprecated. Link property: when the user clicks on this type of link the popup is opened in another JScrib UI viewer
static java.lang.String POINTER
          Deprecated. Default link property: when the user clicks on the link the popup is opened.
static java.lang.String TOOLTIP
          Deprecated. Link property: when the mouse pointer enters the link area the popup appears automatically
 
Constructor Summary
DLinkUtil()
          Deprecated.  
 
Method Summary
static java.lang.String buildTarget(java.lang.String a_method, java.lang.String a_target)
          Deprecated. Returns the target string (i.e. method ':' path) of the link.
static java.lang.String getMethod(IDLink a_link)
          Deprecated.  
static java.lang.String getMethod(java.lang.String a_target)
          Deprecated. Returns method of target link a_target.
static java.lang.String getPath(IDLink a_link)
          Deprecated.  
static java.lang.String getPath(java.lang.String a_target)
          Deprecated. Returns the path of a string link.
static java.lang.String[] getPathItems(IDLink a_link)
          Deprecated. Split path of link at '/' char separator, returns each element in an String array.
static boolean isInternalLink(IDLink a_link)
          Deprecated. Returns true if the link's method is internal, false if the target is an URL.
static boolean isInternalLink(java.lang.String a_target)
          Deprecated. Returns true if the link's target is internal method, false if the target is an URL.
static boolean isPopupLink(IDLink a_link)
          Deprecated. return true is method is a popup-like method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_LINK

public static final java.lang.String DEFAULT_LINK
Deprecated. 
Link property: when the user clicks on this type of link document is moved to target.

See Also:
Constant Field Values

DETACH

public static final java.lang.String DETACH
Deprecated. 
Link property: when the user clicks on this type of link the popup is opened in another JScrib UI viewer

See Also:
Constant Field Values

POINTER

public static final java.lang.String POINTER
Deprecated. 
Default link property: when the user clicks on the link the popup is opened.

See Also:
Constant Field Values

TOOLTIP

public static final java.lang.String TOOLTIP
Deprecated. 
Link property: when the mouse pointer enters the link area the popup appears automatically

See Also:
Constant Field Values
Constructor Detail

DLinkUtil

public DLinkUtil()
Deprecated. 
Method Detail

isInternalLink

public static final boolean isInternalLink(IDLink a_link)
Deprecated. 
Returns true if the link's method is internal, false if the target is an URL.

Returns:
boolean

isInternalLink

public static boolean isInternalLink(java.lang.String a_target)
Deprecated. 
Returns true if the link's target is internal method, false if the target is an URL.


isPopupLink

public static boolean isPopupLink(IDLink a_link)
Deprecated. 
return true is method is a popup-like method.


getMethod

public static java.lang.String getMethod(java.lang.String a_target)
Deprecated. 
Returns method of target link a_target. In JScrib a link has the following syntax:[<method>:<path>]
In JScrib by default there are two link methods (internal / external). An internal method is named jscrib-link. All another names represent an external link (ex: http, file, etc...). A link with an internal method references an IDTaggedItem in the current document or in another.

See Also:
getPath(java.lang.String)

getMethod

public static final java.lang.String getMethod(IDLink a_link)
Deprecated. 
See Also:
getMethod(java.lang.String)

getPath

public static java.lang.String getPath(java.lang.String a_target)
Deprecated. 
Returns the path of a string link. For an internal method the path is the list of parent items with the tag name at the end. Each path items are separated by '/' character. In othercase the path can be an URL, user reference, etc..

See Also:
getPathItems(org.eclipse.tptp.platform.report.core.internal.IDLink)

getPath

public static final java.lang.String getPath(IDLink a_link)
Deprecated. 
See Also:
getPath(String)

getPathItems

public static java.lang.String[] getPathItems(IDLink a_link)
Deprecated. 
Split path of link at '/' char separator, returns each element in an String array. The array item can be null.


buildTarget

public static java.lang.String buildTarget(java.lang.String a_method,
                                           java.lang.String a_target)
Deprecated. 
Returns the target string (i.e. method ':' path) of the link. If a_method is null an internal link method is used to make the string link.

Returns:
string representing target method and path of the link.

TPTP 4.5.0 Platform Project
Internal API Specification