public class DefaultHTMLCallback

  1. Object
  2. DefaultHTMLCallback

ImplementsHTMLCallback, ParserCallback

This is a default implementation of HTMLCallback that basically doesn’t do much but does keep the HTMLComponent work intact. This class was created so developers will avoid pitfalls of HTMLCallback, as using the wrong return values.

Note that in any case an HTMLComponent doesn’t have to use an HTMLCallback.

Fields

public static final int ERROR_CSS_ATTRIBUTE_NOT_SUPPORTED = 200Error code denoting that an unsupported CSS attribute (by XHTML-MP 1.0 standards) was found in the HTML or external CSS files
public static final int ERROR_CSS_ATTIBUTE_VALUE_INVALID = 201Error code denoting that an invalid attribute value was found in the CSS
public static final int ERROR_CSS_NOT_FOUND = 202Error code denoting that a CSS file referenced from the HTML or from another external CSS file was not found
public static final int ERROR_CSS_NO_BASE_URL = 203Error code denoting that a relative URL was referenced from a document with no base URL (A document that was loaded via setBody/setHTML/setDOM and not via setPage) In this case the return value of parsingError is not considered - parsing co…

Constructors

public DefaultHTMLCallback()

Methods

public void titleUpdated(HTMLComponent htmlC, String title){Called when the page’s title is updated}
public boolean parsingError(int errorId, String tag, String attribute, String value, String description){Called when encountering an error while parsing the XML document.
public void pageStatusChanged(HTMLComponent htmlC, int status, String url){Called when the page status has been changed}
public String fieldSubmitted(HTMLComponent htmlC, TextArea ta, String actionURL, String id, String value, int type, String errorMsg){Called whenever a field is submitted to a form.
public String getAutoComplete(HTMLComponent htmlC, String actionURL, String id){Called on form creation and enabled implementations of this method to return a value to preset in a form field.
public int getLinkProperties(HTMLComponent htmlC, String url){Returns properties about the given link to indicate to HTMLComponent how to render it Note that this method is always called NOT on the EDT thread.}
public boolean linkClicked(HTMLComponent htmlC, String url){Called when a link is clicked.
public void actionPerformed(ActionEvent evt, HTMLComponent htmlC, HTMLElement element){Called whenever an ActionEvent is triggered in one of the controls in the HTMLComponent For example, button press, checkbox/radiobutton check etc. This method will be called only if HTMLComponent.isEventsEnabled() is true}
public void focusGained(Component cmp, HTMLComponent htmlC, HTMLElement element){Called when one of the controls in the HTMLComponent obtained focus This method will be called only if HTMLComponent.isEventsEnabled() is true}
public void focusLost(Component cmp, HTMLComponent htmlC, HTMLElement element){Called when one of the controls in the HTMLComponent lost focus This method will be called only if HTMLComponent.isEventsEnabled() is true}
public void selectionChanged(int oldSelected, int newSelected, HTMLComponent htmlC, List list, HTMLElement element){Called when the user selects an item in a List inside the HTMLComponent Note: Selection is traversing through the items - once the user has actually decided, an ActionEvent will be sent as well This method will be called only if HTMLCompon…
public void dataChanged(int type, int index, HTMLComponent htmlC, TextField textField, HTMLElement element){Called when the user types in a TextField inside the HTMLComponent This method will be called only if HTMLComponent.isEventsEnabled() is true}

Inherited fields

From HTMLCallback

ERROR_CONNECTING, ERROR_IMAGE_NOT_FOUND, ERROR_IMAGE_BAD_FORMAT, ERROR_NO_BASE_URL, ERROR_INVALID_TAG_HIERARCHY, STATUS_NONE, STATUS_ERROR, STATUS_CANCELLED, STATUS_REQUESTED, STATUS_CONNECTED, STATUS_PARSED, STATUS_DISPLAYED, STATUS_COMPLETED, STATUS_REDIRECTED, FIELD_TEXT, FIELD_PASSWORD, LINK_REGULAR, LINK_VISTED, LINK_FORBIDDEN

From ParserCallback

ERROR_TAG_NOT_SUPPORTED, ERROR_ATTRIBUTE_NOT_SUPPORTED, ERROR_ATTIBUTE_VALUE_INVALID, ERROR_NO_CLOSE_TAG, ERROR_UNRECOGNIZED_CHAR_ENTITY, ERROR_UNEXPECTED_TAG_CLOSING, ERROR_UNEXPECTED_CHARACTER, ERROR_MULTIPLE_ROOTS, ERROR_NO_ROOTS, ERROR_ENCODING

Inherited methods

From Object

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

Field details

ERROR_CSS_ATTRIBUTE_NOT_SUPPORTED

public static final int ERROR_CSS_ATTRIBUTE_NOT_SUPPORTED = 200
Error code denoting that an unsupported CSS attribute (by XHTML-MP 1.0 standards) was found in the HTML or external CSS files

ERROR_CSS_ATTIBUTE_VALUE_INVALID

public static final int ERROR_CSS_ATTIBUTE_VALUE_INVALID = 201
Error code denoting that an invalid attribute value was found in the CSS

ERROR_CSS_NOT_FOUND

public static final int ERROR_CSS_NOT_FOUND = 202
Error code denoting that a CSS file referenced from the HTML or from another external CSS file was not found

ERROR_CSS_NO_BASE_URL

public static final int ERROR_CSS_NO_BASE_URL = 203
Error code denoting that a relative URL was referenced from a document with no base URL (A document that was loaded via setBody/setHTML/setDOM and not via setPage) In this case the return value of parsingError is not considered - parsing continues and the resource at the URL (CSS file/image) is ignored

Constructor details

DefaultHTMLCallback

public DefaultHTMLCallback()

Method details

titleUpdated

public void titleUpdated(HTMLComponent htmlC, String title)
{Called when the page’s title is updated}

Parameters

htmlC HTMLComponent
The HTMLComponent that triggered the event
title String
The new title

parsingError

public boolean parsingError(int errorId, String tag, String attribute, String value, String description)
{Called when encountering an error while parsing the XML document. When implementing this, the developer should return true if the error should be ignored and the document needs to be further parsed, or false to stop parsing and issue an error to the user Note that this method is always called NOT on the EDT thread.}

Parameters

errorId int
The error ID, one of the ERROR_* constants
tag String
The tag in which the error occured (Can be null for non-tag related errors)
attribute String
The attribute in which the error occured (Can be null for non-attribute related errors)
value String
The value in which the error occured (Can be null for non-value related errors)
description String
A verbal description of the error

Returns

true to continue parsing, false to stop

pageStatusChanged

public void pageStatusChanged(HTMLComponent htmlC, int status, String url)
{Called when the page status has been changed}

Parameters

htmlC HTMLComponent
The HTMLComponent in which the status change occured
status int
The new status, one of the STATUS_* constants
url String
The URL of the page

fieldSubmitted

public String fieldSubmitted(HTMLComponent htmlC, TextArea ta, String actionURL, String id, String value, int type, String errorMsg)
{Called whenever a field is submitted to a form. This can be used to perform sanity checks and/or to store values for auto complete.}

Parameters

htmlC HTMLComponent
The HTMLComponent in which this event occured
ta TextArea
The TextArea/TextField of this field
actionURL String
The action URL of the form
id String
The ID of the field
value String
The value entered
type int
The type of the field, one of the FIELD_* constants
errorMsg String
The error message if any error occured (i.e. input validation error) or null if no error occured

Returns

The string to submit to the form (Should return value if nothing changed)

getAutoComplete

public String getAutoComplete(HTMLComponent htmlC, String actionURL, String id)
{Called on form creation and enabled implementations of this method to return a value to preset in a form field. This can be used to auto complete previously entered value Note that this method is always called NOT on the EDT thread.}

Parameters

htmlC HTMLComponent
The HTMLComponent in which this event occured
actionURL String
The action URL of the form
id String
The ID of the field

Returns

The string to place in the indicated field

getLinkProperties

public int getLinkProperties(HTMLComponent htmlC, String url)
{Returns properties about the given link to indicate to HTMLComponent how to render it Note that this method is always called NOT on the EDT thread.}

Parameters

htmlC HTMLComponent
The HTMLComponent
url String
The Link URL

Returns

LINK_REGULAR or LINK_VISITED or LINK_FORBIDDEN or a mask of those

linkClicked

public boolean linkClicked(HTMLComponent htmlC, String url)
{Called when a link is clicked. This can be used to process links that needs additional/alternate handling than fetching an HTML.}

Parameters

htmlC HTMLComponent
The HTMLComponent
url String
The Link URL

Returns

true if regular link processing should continue, false otherwise

actionPerformed

public void actionPerformed(ActionEvent evt, HTMLComponent htmlC, HTMLElement element)
{Called whenever an ActionEvent is triggered in one of the controls in the HTMLComponent For example, button press, checkbox/radiobutton check etc. This method will be called only if HTMLComponent.isEventsEnabled() is true}

Parameters

evt ActionEvent
The event triggered, the component can be extracted using getSource
htmlC HTMLComponent
The HTMLComponent
element HTMLElement
The element associated with the component that triggered the event

focusGained

public void focusGained(Component cmp, HTMLComponent htmlC, HTMLElement element)
{Called when one of the controls in the HTMLComponent obtained focus This method will be called only if HTMLComponent.isEventsEnabled() is true}

Parameters

cmp Component
The component that triggered the event
htmlC HTMLComponent
The HTMLComponent
element HTMLElement
The element associated with the component that triggered the event

focusLost

public void focusLost(Component cmp, HTMLComponent htmlC, HTMLElement element)
{Called when one of the controls in the HTMLComponent lost focus This method will be called only if HTMLComponent.isEventsEnabled() is true}

Parameters

cmp Component
The component that triggered the event
htmlC HTMLComponent
The HTMLComponent
element HTMLElement
The element associated with the component that triggered the event

selectionChanged

public void selectionChanged(int oldSelected, int newSelected, HTMLComponent htmlC, List list, HTMLElement element)
{Called when the user selects an item in a List inside the HTMLComponent Note: Selection is traversing through the items - once the user has actually decided, an ActionEvent will be sent as well This method will be called only if HTMLComponent.isEventsEnabled() is true}

Parameters

oldSelected int
old selected index in list model
newSelected int
new selected index in list model
htmlC HTMLComponent
The HTMLComponent
list List
The list that triggered the event (Usually a ComboBox but not always)
element HTMLElement
The element associated with the component that triggered the event (Should be TAG_SELECT)

dataChanged

public void dataChanged(int type, int index, HTMLComponent htmlC, TextField textField, HTMLElement element)
{Called when the user types in a TextField inside the HTMLComponent This method will be called only if HTMLComponent.isEventsEnabled() is true}

Parameters

type int
the type data change; REMOVED, ADDED or CHANGED
index int
item index in a list model
htmlC HTMLComponent
The HTMLComponent
textField TextField
The TextField that triggerd the event
element HTMLElement
The element associated with the component that triggered the event (Should be TAG_INPUT with type text/password)