com.aspc.remote.html

Class HTMLAnchor

java.lang.Object

com.aspc.remote.html.HTMLComponent

com.aspc.remote.html.HTMLContainer

com.aspc.remote.html.HTMLAnchor

All Implemented Interfaces:

HandlesMouseEvents, HandlesSingleClick, HTMLAbstractAnchor

Direct Known Subclasses:

HTMLPortalAnchor

public class HTMLAnchor
extends HTMLContainer
implements HTMLAbstractAnchor

HTMLAnchor THREAD MODE: SINGLE-THREADED html generator component

Since:

August 9, 1999, 4:29 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_DIALOG
static java.lang.String	TARGET_BLANK_WINDOW
static java.lang.String	TARGET_PARENT
static java.lang.String	TARGET_SELF
static java.lang.String	TARGET_TOP

Fields inherited from class com.aspc.remote.html.HTMLComponent

alignment, alt, bgColor, cancelBubble, events, gMutableTheme, hasInitFocus, id, intStyleSheet, items, name, parent, styleId, styleProperty, tabIndex, toolTip, VALID_NAME_REGEX, VALID_STYLE_REGEX

Fields inherited from interface com.aspc.remote.html.internal.HTMLAbstractAnchor

URL_CHECK, URL_END, URL_MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
HTMLAnchor(java.lang.String href)

Method Summary

Modifier and Type	Method and Description
void	addCallParameter(java.lang.String encodedToken, java.lang.String encodedValue) add a call parameter
void	addMouseEvent(HTMLMouseEvent me) add a mouse event to this component
void	cancelClickBubble() Prevent the click of the mouse from propagation up the dom and kicking off other things.
protected void	compile(ClientBrowser browser) This is the spot to put all your generation of the HTML components.
java.lang.String	getHREF() get the hyper link for this anchor
java.lang.String	getHREF(ClientBrowser browser) get the hyper link for this anchor
java.lang.String	getId() get the ID of this component
java.lang.String	getTarget()
int	getTargetHeight()
int	getTargetWidth()
boolean	getTargetWindowPlain()
java.lang.String	getURL() get the plain hyper link for this anchor
static java.lang.String	htmlEncodeHREF(java.lang.String rawHREF)
protected void	iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer) generate the raw HTML for this component.
static java.lang.String	makeBondaryCheckURL(java.lang.String url)
static java.lang.String	makeBondaryCheckURL(java.lang.String url, boolean isEncoded)
void	setDialogMode(java.lang.String mode)
void	setId(java.lang.String id) set the ID of this component.
HTMLAnchor	setMaximise(boolean flag)
HTMLAnchor	setMaximise(java.lang.Boolean flag)
void	setMouseOverCursor(java.lang.String cursor)
void	setSdiHeader(java.lang.String header)
HTMLAnchor	setShowNavigateAwayWarning(boolean show)
void	setStyle(java.lang.String styleId)
void	setTarget(java.lang.String callTarget) The window target
void	setTargetHeight(int pixels) The target window height
void	setTargetStatusBar(boolean on) Should the status bar be shown in the target window
void	setTargetWidth(int pixels) The target window width
void	setTargetWindowPlain(boolean on) make the target window plain ie.
void	setToolTip(java.lang.String toolTip) set tooltip
void	setURL(java.lang.String href)
void	showUnderline(boolean show)
java.lang.String	toString()
static boolean	validateHREF(java.lang.String href)

Methods inherited from class com.aspc.remote.html.HTMLContainer

addComponent, addComponent, addText, clear, findId, getComponent, getComponentCount, hasComponent, removeComponent, removeComponent

Methods inherited from class com.aspc.remote.html.HTMLComponent

addJavaScript, addJavaScript, addOnLoadScript, appendClassName, checkIsContainer, copyAttributes, doBuildToolTip, fetchStyleProperty, getClassName, getMutableTheme, getParent, getParentPage, getStyleSheet, getTheme, hasTheme, iAddComponent, iAddComponent, iAddedToPage, iAddEvent, iClear, iFindId, iGenerateAttributes, iGenerateAttributesID, iGenerateComponent, iGenerateComponent, iGenerateEvents, iGetComponent, iGetComponentCount, iHasEvent, iRemoveComponent, isCompiled, iSetId, iSetName, iSetStyleId, makeColorID, makeListOfEvents, monitorPage, postCompile, resetParent, setAlignment, setAttribute, setClassName, setHasInitFocus, setParent, setStyleProperty, setTabIndex, touch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aspc.remote.html.internal.HTMLAbstractAnchor

addComponent, setTabIndex

Field Detail

TARGET_BLANK_WINDOW

public static final java.lang.String TARGET_BLANK_WINDOW

See Also:

Constant Field Values

TARGET_SELF

public static final java.lang.String TARGET_SELF

See Also:

Constant Field Values

TARGET_TOP

public static final java.lang.String TARGET_TOP

See Also:

Constant Field Values

TARGET_PARENT

public static final java.lang.String TARGET_PARENT

See Also:

Constant Field Values

DISABLE_DIALOG

public static final java.lang.String DISABLE_DIALOG

See Also:

Constant Field Values

Constructor Detail

HTMLAnchor

public HTMLAnchor(java.lang.String href)

Parameters:

href -

Method Detail

validateHREF

public static boolean validateHREF(@Nonnull
                                   java.lang.String href)

cancelClickBubble

public void cancelClickBubble()

Prevent the click of the mouse from propagation up the dom and kicking off other things.

Specified by:

cancelClickBubble in interface HandlesSingleClick

setMouseOverCursor

public void setMouseOverCursor(java.lang.String cursor)

Parameters:

cursor -

setURL

public final void setURL(@Nonnull
                         java.lang.String href)

Parameters:

href -

addMouseEvent

public void addMouseEvent(HTMLMouseEvent me)

add a mouse event to this component

Specified by:

addMouseEvent in interface HandlesMouseEvents

Specified by:

addMouseEvent in interface HTMLAbstractAnchor

Parameters:

me - The mouse event

setToolTip

public void setToolTip(java.lang.String toolTip)

Description copied from interface: HTMLAbstractAnchor

set tooltip

Specified by:

setToolTip in interface HTMLAbstractAnchor

Parameters:

toolTip -

setStyle

public void setStyle(java.lang.String styleId)

Parameters:

styleId -

setMaximise

public HTMLAnchor setMaximise(boolean flag)

Parameters:

flag -

Returns:

the value

setMaximise

public HTMLAnchor setMaximise(java.lang.Boolean flag)

Parameters:

flag -

Returns:

the value

getTarget

public java.lang.String getTarget()

Returns:

the value

setTarget

public void setTarget(java.lang.String callTarget)

Description copied from interface: HTMLAbstractAnchor

The window target

Specified by:

setTarget in interface HTMLAbstractAnchor

Parameters:

callTarget -

showUnderline

public void showUnderline(boolean show)

Parameters:

show -

getId

@CheckReturnValue
 @Nullable
public java.lang.String getId()

get the ID of this component

Overrides:

getId in class HTMLComponent

Returns:

the ID

setId

public void setId(java.lang.String id)

set the ID of this component.

Parameters:

id - The id of the component

setTargetWidth

public void setTargetWidth(int pixels)

Description copied from interface: HTMLAbstractAnchor

The target window width

Specified by:

setTargetWidth in interface HTMLAbstractAnchor

Parameters:

pixels -

setTargetHeight

public void setTargetHeight(int pixels)

Description copied from interface: HTMLAbstractAnchor

The target window height

Specified by:

setTargetHeight in interface HTMLAbstractAnchor

Parameters:

pixels -

setTargetWindowPlain

public void setTargetWindowPlain(boolean on)

Description copied from interface: HTMLAbstractAnchor

make the target window plain ie. no menus etc

Specified by:

setTargetWindowPlain in interface HTMLAbstractAnchor

Parameters:

on -

setTargetStatusBar

public void setTargetStatusBar(boolean on)

Description copied from interface: HTMLAbstractAnchor

Should the status bar be shown in the target window

Specified by:

setTargetStatusBar in interface HTMLAbstractAnchor

Parameters:

on -

setDialogMode

public void setDialogMode(java.lang.String mode)

Parameters:

mode -

setSdiHeader

public void setSdiHeader(java.lang.String header)

Parameters:

header -

getTargetWidth

public int getTargetWidth()

Returns:

the value

getTargetHeight

public int getTargetHeight()

Returns:

the value

getTargetWindowPlain

public boolean getTargetWindowPlain()

Returns:

the value

getURL

@CheckReturnValue
 @Nonnull
public java.lang.String getURL()

Description copied from interface: HTMLAbstractAnchor

get the plain hyper link for this anchor

Specified by:

getURL in interface HTMLAbstractAnchor

Returns:

the value

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the value

makeBondaryCheckURL

public static java.lang.String makeBondaryCheckURL(java.lang.String url)

Parameters:

url -

Returns:

the value

makeBondaryCheckURL

public static java.lang.String makeBondaryCheckURL(java.lang.String url,
                                                   boolean isEncoded)

Parameters:

url -

isEncoded -

Returns:

the value

getHREF

@CheckReturnValue
 @Nonnull
public java.lang.String getHREF()

Description copied from interface: HTMLAbstractAnchor

get the hyper link for this anchor

Specified by:

getHREF in interface HTMLAbstractAnchor

Returns:

the href is html escaped, & -> &, ' -> ', " -> "

htmlEncodeHREF

public static java.lang.String htmlEncodeHREF(java.lang.String rawHREF)

getHREF

@CheckReturnValue
 @Nonnull
public java.lang.String getHREF(ClientBrowser browser)

Description copied from interface: HTMLAbstractAnchor

get the hyper link for this anchor

Specified by:

getHREF in interface HTMLAbstractAnchor

Parameters:

browser -

Returns:

the href is html escaped, & -> &, ' -> ', " -> "

setShowNavigateAwayWarning

public HTMLAnchor setShowNavigateAwayWarning(boolean show)

Parameters:

show -

Returns:

the value

compile

protected void compile(ClientBrowser browser)

This is the spot to put all your generation of the HTML components. Do not put it in iGenerate()

Overrides:

compile in class HTMLComponent

Parameters:

browser -

iGenerate

protected void iGenerate(ClientBrowser browser,
                         java.lang.StringBuilder buffer)

generate the raw HTML for this component.

Overrides:

iGenerate in class HTMLComponent

Parameters:

browser - The target browser

buffer - The generate HTML

addCallParameter

public void addCallParameter(java.lang.String encodedToken,
                             java.lang.String encodedValue)

Description copied from interface: HTMLAbstractAnchor

add a call parameter

Specified by:

addCallParameter in interface HTMLAbstractAnchor

Parameters:

encodedToken - The encoded token

encodedValue - the encoded value