public interface HyperlinkControl extends Control, HyperlinkProperties, BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties, MarginStyleProperties, BorderStyleProperties, BootstrapButtonStyle
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.
| Modifier and Type | Method and Description |
|---|---|
Text |
getAriaLabelText()
Returns the
Text object for the aria label text. |
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.
|
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, showgetElementName, getElementTypeaddErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessagesgetActiveTextStyle, getHoverTextStyle, getLinkedTextStyle, getVisitedTextStylegetBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeatgetLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSizegetAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPaddinggetAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargingetBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidthgetBootstrapSize, getBootstrapState, getBootstrapStyle, setBootstrapSize, setBootstrapState, setBootstrapStylejava.lang.String getHref()
useExternalUrl is true.
The URL can be either relative or absolute.
void setHref(java.lang.String href)
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.
boolean isSkipValidation()
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).
void setSkipValidation(boolean skipValidation)
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).
boolean isUseExternalURL()
void setUseExternalURL(boolean useExternalURL)
true, the link type is external, when false the link type is internal.
java.lang.String getTarget()
external.
void setTarget(java.lang.String target)
external.