com.ebasetech.xi.api.controls
Interface HyperlinkControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, Control, Element, EventOwner, HyperlinkProperties, MarginStyleProperties, MessageContainer, PaddingStyleProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner

public interface HyperlinkControl
extends Control, HyperlinkProperties, BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties, MarginStyleProperties, BorderStyleProperties

A Hyperlink Control represents a text displayed as a hyperlink.

A hyperlink can be either external meaning that the link is to a URL outside of the current form, or internal meaning that the link should trigger an internal event. This is configured by property useExternalUrl.

When the link is configured as external, the hyperlink can be configured with properties hRef and target; when the link is internal, the event scripts are configured in the designer via the On Click event.

Further documentation.

Method Summary

java.lang.String	getHref() The URL of the hyperlink when property useExternalUrl is true.
java.lang.String	getTarget() The target window id when the link is configured as external.
Text	getText() Returns the Text object for the hyperlink text.
Text	getTitle() Returns the Text object for the mouse over text.
boolean	isSkipValidation() Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event.
boolean	isUseExternalURL() Indicates whether the link is external or internal.
void	setHref(java.lang.String href) Sets the URL of the hyperlink when property useExternalUrl is true.
void	setSkipValidation(boolean skipValidation) Specifies whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event.
void	setTarget(java.lang.String target) Sets the target window id when the link is configured as external.
void	setUseExternalURL(boolean useExternalURL) Sets the link type.

Methods inherited from interface com.ebasetech.xi.api.controls.Control

getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.MessageContainer

addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, existErrorMessages, existMessages, existWarningMessages

Methods inherited from interface com.ebasetech.xi.api.controls.HyperlinkProperties

getActiveTextStyle, getHoverTextStyle, getLinkedTextStyle, getVisitedTextStyle

Methods inherited from interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

Methods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties

getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize

Methods inherited from interface com.ebasetech.xi.api.controls.PaddingStyleProperties

getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding

Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Method Detail

getText

Text getText()

Returns the Text object for the hyperlink text.

Since:

V4.4

getHref

java.lang.String getHref()

The URL of the hyperlink when property useExternalUrl is true. The URL can be either relative or absolute.

Further documentation.

Since:

V4.4

setHref

void setHref(java.lang.String href)

Sets the URL of the hyperlink when property useExternalUrl is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

Further documentation.

Since:

V4.4

getTitle

Text getTitle()

Returns the Text object for the mouse over text.

Since:

V4.4

isSkipValidation

boolean isSkipValidation()

Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event.

Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

Further documentation.

Since:

V4.4

setSkipValidation

void setSkipValidation(boolean skipValidation)

Specifies whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event.

Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

Further documentation.

Since:

V4.4

isUseExternalURL

boolean isUseExternalURL()

Indicates whether the link is external or internal.

• external: the link is to a URL outside of the current form
• internal: the link triggers an internal event

Further documentation.

Since:

V4.4

setUseExternalURL

void setUseExternalURL(boolean useExternalURL)

Sets the link type. When true, the link type is external, when false the link type is internal.

Further documentation.

Since:

V4.4

getTarget

java.lang.String getTarget()

The target window id when the link is configured as external.

Further documentation.

Since:

V4.4

setTarget

void setTarget(java.lang.String target)

Sets the target window id when the link is configured as external.

Further documentation.

Since:

V4.4