com.aspc.remote.html

Class HTMLPage

java.lang.Object

com.aspc.remote.html.HTMLComponent

com.aspc.remote.html.HTMLContainer

com.aspc.remote.html.HTMLPanel

com.aspc.remote.html.HTMLPage

Direct Known Subclasses:

SuperTrackerPage

public class HTMLPage
extends HTMLPanel

HTMLPage THREAD MODE: SINGLE-THREADED HTML generator component

Since:

June 12, 1999, 3:54 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	bottomMargin bottom margin for the html page
protected java.lang.String	leftmargin left margin for html page
protected java.lang.String	linkExternalScripts Link External Script
protected java.lang.String	marginheight margin height for html page
protected java.lang.String	marginwidth margin width
protected java.lang.String	rightmargin Right margin for html page
static java.lang.String	SCROLLBAR_AUTO This value is browser and media dependent, but should allow for a horizontal scrollbar if possible in case of overflow.
static java.lang.String	SCROLLBAR_HIDDEN Content is clipped and content outside of the element's box is not visible.
static java.lang.String	SCROLLBAR_SCROLL Content is clipped as necessary, but a horizontal scrollbar is made available where necessary to view the additional, non-visible content.
static java.lang.String	SCROLLBAR_VISIBLE Content is not clipped and may be rendered outside of the element's box.
protected java.lang.String	topmargin top margin for html page

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

Constructor Summary

Constructors

Constructor and Description
HTMLPage() Constructor
HTMLPage(int version)

Method Summary

Modifier and Type	Method and Description
void	addComponent(HTMLComponent component, int index) Adds a component to this container at a particular position
void	addGWT(java.lang.String module) add a GWT module.
void	addHeadComponent(HTMLComponent comp)
void	addHeadTag(java.lang.String headerTag)
void	addJavaScript(JavaScript script)
void	addJavaScript(java.lang.String scriptListing)
void	addJavaScriptLink(java.lang.String url, ScriptLink.LoadType loadType)
void	addJavaScriptLink(java.lang.String url, ScriptLink.LoadType loadType, java.lang.String cdnFallBackScript)
void	addJavaScriptVariable(java.lang.String scriptVariable) HTMLArea needs a variable to be set up before loading the java scripts
void	addLink(java.lang.String tag, int index)
void	addLink(java.lang.String rel, java.lang.String href)
void	addMeta(java.lang.String name, java.lang.String content)
HTMLPage	addModule(java.lang.String module) add a module.
void	addPreRefreshCall(java.lang.String heads)
void	addStateEvent(HTMLStateEvent sEvent)
void	addStyleSheet(java.lang.String url) append a style sheet
void	addStyleSheet(java.lang.String url, java.lang.String media) append a style sheet
void	addStyleSheet(java.lang.String url, java.lang.String media, int index) prepend a style sheet
HTMLPage	addToDictionary(java.lang.String dictionaryCode, java.lang.String code, java.lang.String value) add to the page's dictionary.
void	addToList(java.lang.String code, java.lang.String value)
protected void	compile(ClientBrowser browser) This is the spot to put all your generation of the HTML components.
java.lang.String	doGenerateId() Generates a new unique identifier for new components that do not have any other way of generating one for themselves.
int	getDictionarySize(java.lang.String dictionaryCode)
java.lang.String	getFavIconPath()
java.lang.String	getFlag(java.lang.String name) gets General purpose flags for your own component's use
java.lang.String	getHost()
java.lang.String	getId() get the ID of this component
java.lang.String	getPageClass()
boolean	getPleaseWaitHook()
int	getRefreshTime()
static long	getStartTime()
Status	getStatus()
StyleSheetInterface	getStyle(int index)
java.lang.String	getTitle() The page title.
int	getVersion()
java.lang.Object	getWorkingStorage(java.lang.String key) get the temporary working storage value
java.lang.String	getXUACompatible()
protected void	iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer) generate the raw HTML for this component.
protected void	iGenerateJSLibrary(ClientBrowser browser, java.lang.StringBuilder buffer)
void	iGenerateSuper(ClientBrowser browser, java.lang.StringBuilder buffer) generate the raw WML for this component.
boolean	isPageCompiled()
boolean	listContains(java.lang.String code, java.lang.String value)
java.lang.String[]	listCSS() the CSS links
java.lang.String[]	listScripts()
protected HTMLPage	monitorPage()
void	putFlag(java.lang.String name, java.lang.String value) puts General purpose flags for your own component's use
void	registerStyleSheet(StyleSheetInterface s)
void	setBackGroundColor(java.awt.Color color)
void	setBackgroundImage(java.lang.String imageSrc)
void	setBackgroundImage(java.lang.String imageSrc, boolean fixedPosition)
void	setBackgroundImageFullPage(java.lang.String imageSrc)
void	setBottomMargin(java.lang.String margin)
HTMLPage	setDescription(java.lang.String description) set the description
HTMLPage	setFavIconPath(java.lang.String path) set the favorite icon path
HTMLPage	setGooglePlusID(java.lang.String googleplusid) set the Google plus ID
protected void	setHasFrameSet(boolean flag)
void	setHorizontalScrollBar(java.lang.String scroll)
void	setHost(java.lang.String host) add this host to the css links if it's not blank this host must include protocol, or starts with '//'
void	setId(java.lang.String id) set the ID of this component.
HTMLPage	setKeywords(java.lang.String keywords) set the keywords
void	setLeftMargin(java.lang.String id)
void	setLinkExternalScripts(boolean flag)
void	setMarginHeight(java.lang.String id)
void	setMarginWidth(java.lang.String id)
HTMLPage	setOgDescription(java.lang.String ogDescription) Set the Open Graph protocol description http://ogp.me/
void	setOgImage(java.lang.String ogImage)
void	setOgSiteName(java.lang.String ogSiteName)
HTMLPage	setOgTitle(java.lang.String ogTitle) Set the og Title
HTMLPage	setOgType(java.lang.String ogType) Set the Open Graph protocol type http://ogp.me/
void	setOgURL(java.lang.String ogURL)
void	setPageClass(java.lang.String pageClass)
void	setPleaseWaitHook(boolean addPleaseWait)
void	setRefreshTime(int secs)
void	setRightMargin(java.lang.String id)
void	setShowNavigateAwayWarning(boolean flag)
HTMLPage	setStatus(Status status)
protected void	setTheme() theme for page
void	setTheme(HTMLMutableTheme theme)
HTMLPage	setTitle(java.lang.String title) set the title
void	setToolTip(java.lang.String toolTip)
void	setTopMargin(java.lang.String id)
void	setVerticalScrollBar(java.lang.String scroll)
void	setWorkingStorage(java.lang.String key, java.lang.Object value) set the temporary working storage variable
void	setXUACompatible(java.lang.String XUACompatible)
boolean	showNavigateAwayWarning()

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

generate, generate, generateHTMLFile, generateText, registerPostCompileCallBack, setParent, writeToFile

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

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, postCompile, resetParent, setAlignment, setAttribute, setClassName, setHasInitFocus, setStyleProperty, setTabIndex, touch

Methods inherited from class java.lang.Object

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

Field Detail

SCROLLBAR_HIDDEN

public static final java.lang.String SCROLLBAR_HIDDEN

Content is clipped and content outside of the element's box is not visible. The size of the clipping region is defined by the 'clip' property.

See Also:

Constant Field Values

SCROLLBAR_VISIBLE

public static final java.lang.String SCROLLBAR_VISIBLE

Content is not clipped and may be rendered outside of the element's box.

See Also:

Constant Field Values

SCROLLBAR_SCROLL

public static final java.lang.String SCROLLBAR_SCROLL

Content is clipped as necessary, but a horizontal scrollbar is made available where necessary to view the additional, non-visible content. If the Visual media in use is static (such as Print) the content should be treated as if the value was 'visible'.

See Also:

Constant Field Values

SCROLLBAR_AUTO

public static final java.lang.String SCROLLBAR_AUTO

This value is browser and media dependent, but should allow for a horizontal scrollbar if possible in case of overflow.

See Also:

Constant Field Values

topmargin

protected java.lang.String topmargin

top margin for html page

bottomMargin

protected java.lang.String bottomMargin

bottom margin for the html page

leftmargin

protected java.lang.String leftmargin

left margin for html page

linkExternalScripts

protected java.lang.String linkExternalScripts

Link External Script

rightmargin

protected java.lang.String rightmargin

Right margin for html page

marginheight

protected java.lang.String marginheight

margin height for html page

marginwidth

protected java.lang.String marginwidth

margin width

Constructor Detail

HTMLPage

public HTMLPage()

Constructor

HTMLPage

public HTMLPage(int version)

Parameters:

version - 1 for old page mode

Method Detail

setPageClass

public void setPageClass(java.lang.String pageClass)

getPageClass

public java.lang.String getPageClass()

setStatus

public HTMLPage setStatus(@Nonnull
                          Status status)

getStatus

@CheckReturnValue
 @Nonnull
public Status getStatus()

monitorPage

protected HTMLPage monitorPage()

Overrides:

monitorPage in class HTMLComponent

getVersion

public int getVersion()

Returns:

is t

addModule

public HTMLPage addModule(java.lang.String module)

add a module.

Parameters:

module - the module to add.

Returns:

This page.

addComponent

public void addComponent(HTMLComponent component,
                         int index)
                  throws java.lang.ArrayIndexOutOfBoundsException

Description copied from class: HTMLContainer

Adds a component to this container at a particular position

Overrides:

addComponent in class HTMLContainer

Throws:

java.lang.ArrayIndexOutOfBoundsException

addJavaScriptLink

public void addJavaScriptLink(@Nullable
                              java.lang.String url,
                              @Nonnull
                              ScriptLink.LoadType loadType)

Parameters:

url - the script URL

loadType - the type of loading.

addJavaScriptLink

public void addJavaScriptLink(@Nullable
                              java.lang.String url,
                              @Nonnull
                              ScriptLink.LoadType loadType,
                              @Nullable
                              java.lang.String cdnFallBackScript)

Parameters:

url - the script URL

loadType - the type of loading.

cdnFallBackScript - CDN fall back script.

setLinkExternalScripts

public void setLinkExternalScripts(boolean flag)

Parameters:

flag -

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

setShowNavigateAwayWarning

public void setShowNavigateAwayWarning(boolean flag)

Parameters:

flag -

showNavigateAwayWarning

public boolean showNavigateAwayWarning()

Returns:

the value

setTopMargin

public void setTopMargin(java.lang.String id)

Parameters:

id -

setBottomMargin

public void setBottomMargin(java.lang.String margin)

Parameters:

margin -

setLeftMargin

public void setLeftMargin(java.lang.String id)

Parameters:

id -

setRightMargin

public void setRightMargin(java.lang.String id)

Parameters:

id -

setMarginHeight

public void setMarginHeight(java.lang.String id)

Parameters:

id -

setMarginWidth

public void setMarginWidth(java.lang.String id)

Parameters:

id -

getStyle

public StyleSheetInterface getStyle(int index)

Parameters:

index -

Returns:

the value

registerStyleSheet

public void registerStyleSheet(StyleSheetInterface s)

Parameters:

s - the style sheet

addHeadComponent

public void addHeadComponent(HTMLComponent comp)

Parameters:

comp -

addStyleSheet

public void addStyleSheet(java.lang.String url)

append a style sheet

Parameters:

url - append a style sheet

addStyleSheet

public void addStyleSheet(java.lang.String url,
                          java.lang.String media)

append a style sheet

Parameters:

url - append a style sheet

media - the media

addLink

public void addLink(@Nonnull
                    java.lang.String rel,
                    @Nonnull
                    java.lang.String href)

addLink

public void addLink(java.lang.String tag,
                    int index)

Parameters:

tag - the attributes in this tag must be html encoded, such as <script src="/abc.js?a=b&amp;c=d"/>

index -

addStyleSheet

public void addStyleSheet(@Nonnull
                          java.lang.String url,
                          @Nullable
                          java.lang.String media,
                          int index)

prepend a style sheet

Parameters:

url - append a style

media - the media for this style sheet

index - the index

addJavaScript

public void addJavaScript(@Nonnull
                          JavaScript script)

Parameters:

script -

listScripts

public java.lang.String[] listScripts()

Returns:

the value

listCSS

public java.lang.String[] listCSS()

the CSS links

Returns:

the list of CSS links

addJavaScriptVariable

public void addJavaScriptVariable(java.lang.String scriptVariable)

HTMLArea needs a variable to be set up before loading the java scripts

Parameters:

scriptVariable -

setToolTip

public void setToolTip(java.lang.String toolTip)

Parameters:

toolTip -

addStateEvent

public void addStateEvent(HTMLStateEvent sEvent)

Parameters:

sEvent -

addJavaScript

public void addJavaScript(@Nonnull
                          java.lang.String scriptListing)

Parameters:

scriptListing -

addGWT

public void addGWT(java.lang.String module)

add a GWT module. If any modules added then include a call for /scripts/gwt.js into the page.

Parameters:

module - the module to add.

addMeta

public void addMeta(@Nonnull
                    java.lang.String name,
                    @Nonnull
                    java.lang.String content)

addHeadTag

public void addHeadTag(@Nonnull
                       java.lang.String headerTag)

Parameters:

headerTag -

addPreRefreshCall

public void addPreRefreshCall(java.lang.String heads)

Parameters:

heads -

compile

protected void compile(@Nonnull
                       ClientBrowser browser)

Description copied from class: HTMLComponent

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 -

getXUACompatible

public java.lang.String getXUACompatible()

setXUACompatible

public void setXUACompatible(java.lang.String XUACompatible)

getTitle

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

The page title.

Returns:

the title

setTitle

@Nonnull
public HTMLPage setTitle(@Nullable
                                  java.lang.String title)

set the title

Parameters:

title - the title

Returns:

this

setDescription

@Nonnull
public HTMLPage setDescription(@Nullable
                                        java.lang.String description)

set the description

Parameters:

description - the description

Returns:

this

setKeywords

public HTMLPage setKeywords(@Nullable
                            java.lang.String keywords)

set the keywords

Parameters:

keywords - the keywords

Returns:

this

setBackGroundColor

public void setBackGroundColor(java.awt.Color color)

Parameters:

color -

setRefreshTime

public void setRefreshTime(int secs)

Parameters:

secs -

getRefreshTime

public int getRefreshTime()

setBackgroundImage

public void setBackgroundImage(java.lang.String imageSrc)

Parameters:

imageSrc -

setBackgroundImageFullPage

public void setBackgroundImageFullPage(java.lang.String imageSrc)

Parameters:

imageSrc -

setBackgroundImage

public void setBackgroundImage(java.lang.String imageSrc,
                               boolean fixedPosition)

Parameters:

imageSrc -

fixedPosition -

getHost

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

setHost

public void setHost(@Nonnull
                    java.lang.String host)

add this host to the css links if it's not blank this host must include protocol, or starts with '//'

Parameters:

host -

iGenerateSuper

public void iGenerateSuper(ClientBrowser browser,
                           java.lang.StringBuilder buffer)

generate the raw WML for this component.

Parameters:

browser - The target browser

buffer - The generate WML

iGenerate

protected void iGenerate(@Nonnull
                         ClientBrowser browser,
                         @Nonnull
                         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

putFlag

public void putFlag(java.lang.String name,
                    java.lang.String value)

puts General purpose flags for your own component's use

Parameters:

name -

value - the value

setTheme

public void setTheme(HTMLMutableTheme theme)

Parameters:

theme -

getFlag

@CheckReturnValue
 @Nonnull
public java.lang.String getFlag(@Nonnull
                                                            java.lang.String name)

gets General purpose flags for your own component's use

Parameters:

name -

Returns:

the value

doGenerateId

public java.lang.String doGenerateId()

Generates a new unique identifier for new components that do not have any other way of generating one for themselves.

Returns:

the value

getStartTime

public static long getStartTime()

Returns:

the value

iGenerateJSLibrary

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

Parameters:

browser -

buffer -

setHasFrameSet

protected void setHasFrameSet(boolean flag)

Parameters:

flag -

setTheme

protected final void setTheme()

theme for page

setPleaseWaitHook

public void setPleaseWaitHook(boolean addPleaseWait)

Parameters:

addPleaseWait -

getPleaseWaitHook

public boolean getPleaseWaitHook()

Returns:

the value

setHorizontalScrollBar

public void setHorizontalScrollBar(java.lang.String scroll)

Parameters:

scroll -

setWorkingStorage

public void setWorkingStorage(java.lang.String key,
                              java.lang.Object value)

set the temporary working storage variable

Parameters:

key - the key value

value - the value

getWorkingStorage

public java.lang.Object getWorkingStorage(java.lang.String key)

get the temporary working storage value

Parameters:

key - the key

Returns:

the value

isPageCompiled

public boolean isPageCompiled()

Returns:

the value

setVerticalScrollBar

public void setVerticalScrollBar(java.lang.String scroll)

Parameters:

scroll -

listContains

public boolean listContains(java.lang.String code,
                            java.lang.String value)

Parameters:

code -

value - the value

Returns:

the value

addToList

public void addToList(java.lang.String code,
                      java.lang.String value)

Parameters:

code -

value - the value

addToDictionary

@Nonnull
public HTMLPage addToDictionary(@Nonnull
                                         java.lang.String dictionaryCode,
                                         @Nonnull
                                         java.lang.String code,
                                         @Nullable
                                         java.lang.String value)

add to the page's dictionary.

Parameters:

dictionaryCode -

code -

value - the value to add, if null/blank the code will be removed

Returns:

this

getDictionarySize

@Nonnegative
public int getDictionarySize(@Nonnull
                                          java.lang.String dictionaryCode)

setOgURL

public void setOgURL(java.lang.String ogURL)

setOgSiteName

public void setOgSiteName(java.lang.String ogSiteName)

setOgImage

public void setOgImage(java.lang.String ogImage)

setOgTitle

@Nonnull
public HTMLPage setOgTitle(@Nullable
                                    java.lang.String ogTitle)

Set the og Title

Parameters:

ogTitle -

Returns:

this

setOgType

@Nonnull
public HTMLPage setOgType(@Nullable
                                   java.lang.String ogType)

Set the Open Graph protocol type http://ogp.me/

Parameters:

ogType -

Returns:

this

setOgDescription

@Nonnull
public HTMLPage setOgDescription(@Nullable
                                          java.lang.String ogDescription)

Set the Open Graph protocol description http://ogp.me/

Parameters:

ogDescription -

Returns:

this

setGooglePlusID

@Nonnull
public HTMLPage setGooglePlusID(java.lang.String googleplusid)

set the Google plus ID

Parameters:

googleplusid -

Returns:

this

getFavIconPath

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

setFavIconPath

@Nonnull
public HTMLPage setFavIconPath(@Nullable
                                        java.lang.String path)

set the favorite icon path

Parameters:

path -

Returns:

this