com.aspc.remote.html

Class HTMLComponent

java.lang.Object

com.aspc.remote.html.HTMLComponent

Direct Known Subclasses:

HTMLAjaxFieldV2, HTMLApplet, HTMLButton, HTMLContainer, HTMLDatePicker, HtmlDBClass, HtmlDBClassTree, HTMLDisplayField, HTMLEventPeriodSelection, HTMLFormComponent, HTMLFrame, HTMLHorizontalRule, HTMLLabel, HTMLListText, HTMLPortalButton, HTMLPortalDuplicateButton, HTMLPostItNote, HTMLRecurrenceRule, HTMLRichText, HTMLSchedule, HTMLTabPanel, HTMLTags, HTMLText, HTMLTimePicker, HTMLWorkDaySelection

public abstract class HTMLComponent
extends java.lang.Object

HTMLComponent
THREAD MODE: SINGLE-THREADED HTML generator component

Since:

June 26, 1999, 2:13 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alignment
protected java.lang.String	alt
protected java.awt.Color	bgColor
protected boolean	cancelBubble
protected java.util.ArrayList<HTMLEvent>	events
protected HTMLMutableTheme	gMutableTheme
protected java.lang.Boolean	hasInitFocus
protected java.lang.String	id
protected HTMLStyleSheet	intStyleSheet
protected java.util.ArrayList<HTMLComponent>	items
protected java.lang.String	name
protected HTMLComponent	parent
protected java.lang.String	styleId
protected java.util.HashMap	styleProperty
protected java.lang.Integer	tabIndex
protected java.lang.String	toolTip
static java.lang.String	VALID_NAME_REGEX http://www.w3.org/TR/html4/types.html#type-id
static java.lang.String	VALID_STYLE_REGEX Valid style

Constructor Summary

Constructors

Constructor and Description
HTMLComponent()

Method Summary

Modifier and Type	Method and Description
void	addJavaScript(java.lang.String token, JavaScript script)
void	addJavaScript(java.lang.String token, java.lang.String scr)
void	addOnLoadScript(java.lang.String token, java.lang.String script)
void	appendClassName(java.lang.String className) Append a class name to the existing class names ( if name).
protected void	checkIsContainer() Just Create the items vector if needed
protected void	compile(ClientBrowser browser) This is the spot to put all your generation of the HTML components.
protected void	copyAttributes(HTMLComponent table)
protected void	doBuildToolTip(ClientBrowser browser) Protected methods
java.lang.String	fetchStyleProperty(java.lang.String type) get the style property if set
java.lang.String	getClassName()
java.lang.String	getId() get the ID of this component
HTMLMutableTheme	getMutableTheme() Returns a mutable theme
HTMLComponent	getParent()
protected HTMLPage	getParentPage()
protected HTMLStyleSheet	getStyleSheet()
HTMLTheme	getTheme() Returns the current theme or an Overlay theme if one doesn't exists.
boolean	hasTheme() Test to see if this component has a Theme ( without creating one)
protected void	iAddComponent(HTMLComponent component) Adds a component to this container
protected void	iAddComponent(HTMLComponent component, int index) Adds a component to this container at a particular position
protected void	iAddedToPage(HTMLPage page)
void	iAddEvent(HTMLEvent event, java.lang.String script) INTERNAL ONLY Adds the event to the event list.
protected void	iClear()
protected HTMLComponent	iFindId(java.lang.String searchId)
protected void	iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer) This is the method that creates the raw HTML.
protected void	iGenerateAttributes(ClientBrowser browser, java.lang.StringBuilder buffer)
protected void	iGenerateAttributesID(ClientBrowser browser, java.lang.StringBuilder buffer)
protected void	iGenerateComponent(HTMLComponent c, ClientBrowser browser, int count, java.lang.StringBuilder buffer)
protected void	iGenerateComponent(HTMLComponent c, ClientBrowser browser, java.lang.StringBuilder buffer)
protected void	iGenerateEvents(ClientBrowser browser, java.lang.StringBuilder buffer)
protected HTMLComponent	iGetComponent(int at)
protected int	iGetComponentCount() The count of components contained
protected boolean	iHasEvent(java.lang.String eventName)
protected void	iRemoveComponent(int at) Remove component from the container
boolean	isCompiled()
protected void	iSetId(java.lang.String id) set the ID of this component.
protected void	iSetName(java.lang.String inName)
protected void	iSetStyleId(java.lang.String styleId)
static java.lang.String	makeColorID(java.awt.Color color)
protected void	makeListOfEvents(java.util.List<HTMLEvent> list)
protected HTMLPage	monitorPage()
protected void	postCompile(ClientBrowser browser) This is the post compile if needed
protected void	resetParent()
void	setAlignment(java.lang.String alignment)
void	setAttribute(java.lang.String name, java.lang.String value)
void	setClassName(java.lang.String className) Clears all of the object's style names and sets it to the given style.
void	setHasInitFocus(boolean fg) Sets whether this component receives focus when the page is loaded If value is not set then the component with tab index of one will receive the focus
protected void	setParent(HTMLComponent parent) Set the parent of this component internally called by addComponent
void	setStyleProperty(java.lang.String type, java.lang.String value) Set the internal style of this component. if this method is used for a component, this component will be appended a class attribute. If this method is used, iGenerateAttributes() method must be used to generate the CSS.
void	setTabIndex(int tabIndex) Sets the index that defines the tab order for the Component The tabIndex value determines the tab order as follows: 1.
void	touch()

Methods inherited from class java.lang.Object

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

Field Detail

VALID_NAME_REGEX

public static final java.lang.String VALID_NAME_REGEX

http://www.w3.org/TR/html4/types.html#type-id

See Also:

Constant Field Values

VALID_STYLE_REGEX

public static final java.lang.String VALID_STYLE_REGEX

Valid style

See Also:

Constant Field Values

alt

protected java.lang.String alt

parent

protected HTMLComponent parent

alignment

protected java.lang.String alignment

id

protected java.lang.String id

name

protected java.lang.String name

styleId

protected java.lang.String styleId

toolTip

protected java.lang.String toolTip

tabIndex

protected java.lang.Integer tabIndex

hasInitFocus

protected java.lang.Boolean hasInitFocus

gMutableTheme

protected HTMLMutableTheme gMutableTheme

events

protected java.util.ArrayList<HTMLEvent> events

bgColor

protected java.awt.Color bgColor

items

protected java.util.ArrayList<HTMLComponent> items

cancelBubble

protected boolean cancelBubble

styleProperty

protected java.util.HashMap styleProperty

intStyleSheet

protected HTMLStyleSheet intStyleSheet

Constructor Detail

HTMLComponent

public HTMLComponent()

Method Detail

touch

public void touch()

setClassName

public final void setClassName(@Nullable
                               java.lang.String className)

Clears all of the object's style names and sets it to the given style.

Parameters:

className - the class name to set.

appendClassName

public final void appendClassName(@Nullable
                                  java.lang.String className)

Append a class name to the existing class names ( if name).

Parameters:

className - the class name to append.

getClassName

@Nonnull
 @CheckReturnValue
public final java.lang.String getClassName()

Returns:

the style class

addJavaScript

public void addJavaScript(@Nonnull
                          java.lang.String token,
                          @Nullable
                          java.lang.String scr)

Parameters:

token - The token

scr -

addJavaScript

public void addJavaScript(@Nonnull
                          java.lang.String token,
                          @Nullable
                          JavaScript script)

Parameters:

token - The token

script -

addOnLoadScript

public void addOnLoadScript(@Nonnull
                            java.lang.String token,
                            @Nullable
                            java.lang.String script)

Parameters:

token - The token

script -

iFindId

@CheckReturnValue
 @Nullable
protected HTMLComponent iFindId(@Nullable
                                                             java.lang.String searchId)

Parameters:

searchId -

Returns:

the value

getId

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

get the ID of this component

Returns:

the ID

iSetId

protected void iSetId(@Nullable
                      java.lang.String id)

set the ID of this component.

Parameters:

id - The id of the component

iSetName

protected void iSetName(@Nonnull
                        java.lang.String inName)

Parameters:

inName -

iSetStyleId

protected void iSetStyleId(java.lang.String styleId)

Parameters:

styleId -

iGenerateComponent

protected void iGenerateComponent(HTMLComponent c,
                                  ClientBrowser browser,
                                  int count,
                                  java.lang.StringBuilder buffer)

Parameters:

c -

browser -

count -

buffer -

iAddEvent

public void iAddEvent(HTMLEvent event,
                      java.lang.String script)

INTERNAL ONLY Adds the event to the event list. NB: Was protected but JDK1.4 complains.

Parameters:

event - the event

script -

iHasEvent

protected boolean iHasEvent(java.lang.String eventName)

Parameters:

eventName -

Returns:

the value

isCompiled

@CheckReturnValue
public boolean isCompiled()

Returns:

the value

monitorPage

@CheckReturnValue
 @Nullable
protected HTMLPage monitorPage()

compile

protected void compile(@Nonnull
                       ClientBrowser browser)

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

Parameters:

browser -

postCompile

@OverridingMethodsMustInvokeSuper
protected void postCompile(ClientBrowser browser)

This is the post compile if needed

Parameters:

browser -

resetParent

protected void resetParent()

makeListOfEvents

protected void makeListOfEvents(@Nonnull
                                java.util.List<HTMLEvent> list)

Parameters:

list -

setAlignment

public void setAlignment(@Nullable
                         java.lang.String alignment)

Parameters:

alignment -

setTabIndex

public void setTabIndex(int tabIndex)

Sets the index that defines the tab order for the Component
The tabIndex value determines the tab order as follows:

1. Objects with a positive tabIndex are selected in
increasing index order and in source order to resolve
duplicates.
2. Objects with a tabIndex of zero are selected in source order.
3. Objects with a negative tabIndex are omitted from the tabbing
order.

Parameters:

tabIndex -

setHasInitFocus

public void setHasInitFocus(boolean fg)

Sets whether this component receives focus when the page is loaded
If value is not set then the component with tab index of one will
receive the focus

Parameters:

fg -

setParent

protected void setParent(HTMLComponent parent)

Set the parent of this component internally called by addComponent

Parameters:

parent -

iAddedToPage

protected void iAddedToPage(HTMLPage page)

Parameters:

page -

getParentPage

@CheckReturnValue
 @Nullable
protected HTMLPage getParentPage()

Returns:

the value

getParent

@CheckReturnValue
 @Nullable
public HTMLComponent getParent()

Returns:

the value

makeColorID

@CheckReturnValue
 @Nonnull
public static java.lang.String makeColorID(@Nonnull
                                                                       java.awt.Color color)

Parameters:

color -

Returns:

the value

fetchStyleProperty

@CheckReturnValue
 @Nullable
public java.lang.String fetchStyleProperty(java.lang.String type)

get the style property if set

Parameters:

type - the property

Returns:

the value NULL if not set

setStyleProperty

public void setStyleProperty(@Nonnull
                             java.lang.String type,
                             @Nullable
                             java.lang.String value)

Set the internal style of this component.
if this method is used for a component, this component will be appended a class attribute.
If this method is used, iGenerateAttributes() method must be used to generate the CSS.

Parameters:

type - the type

value - the value

setAttribute

public void setAttribute(@Nonnull
                         java.lang.String name,
                         @Nonnull
                         java.lang.String value)

iGenerateAttributesID

protected void iGenerateAttributesID(ClientBrowser browser,
                                     @Nonnull
                                     java.lang.StringBuilder buffer)

Parameters:

browser -

buffer -

iGenerateAttributes

protected void iGenerateAttributes(ClientBrowser browser,
                                   @Nonnull
                                   java.lang.StringBuilder buffer)

Parameters:

browser -

buffer -

iGenerateEvents

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

Parameters:

browser -

buffer -

doBuildToolTip

protected void doBuildToolTip(@Nonnull
                              ClientBrowser browser)

Protected methods

Parameters:

browser -

iGetComponent

@CheckReturnValue
 @Nullable
protected HTMLComponent iGetComponent(int at)

Parameters:

at -

Returns:

the value

checkIsContainer

protected void checkIsContainer()

Just Create the items vector if needed

iAddComponent

protected void iAddComponent(@Nullable
                             HTMLComponent component)

Adds a component to this container

Parameters:

component -

iAddComponent

protected void iAddComponent(HTMLComponent component,
                             int index)
                      throws java.lang.ArrayIndexOutOfBoundsException

Adds a component to this container at a particular position

Parameters:

component -

index -

Throws:

java.lang.ArrayIndexOutOfBoundsException

iRemoveComponent

protected void iRemoveComponent(int at)

Remove component from the container

Parameters:

at -

iGetComponentCount

@CheckReturnValue
protected int iGetComponentCount()

The count of components contained

Returns:

the value

iClear

protected void iClear()

iGenerate

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

This is the method that creates the raw HTML. DO NOT CREATE ANY HTMLComponents IN HERE. Do it in the compile method.

Parameters:

browser - The target browser

buffer - The generate HTML

hasTheme

@CheckReturnValue
public boolean hasTheme()

Test to see if this component has a Theme ( without creating one)

Returns:

the value

getMutableTheme

@CheckReturnValue
 @Nonnull
public HTMLMutableTheme getMutableTheme()

Returns a mutable theme

Returns:

the value

getTheme

@CheckReturnValue
 @Nonnull
public HTMLTheme getTheme()

Returns the current theme or an Overlay theme if one doesn't exists.

Returns:

the value

iGenerateComponent

protected void iGenerateComponent(HTMLComponent c,
                                  ClientBrowser browser,
                                  java.lang.StringBuilder buffer)

Parameters:

c -

browser -

buffer -

getStyleSheet

@CheckReturnValue
protected HTMLStyleSheet getStyleSheet()

Returns:

the value

copyAttributes

protected void copyAttributes(HTMLComponent table)

Parameters:

table -