HTMLComponent (Codename One API)

java.lang.Object
- com.codename1.ui.Component
- - com.codename1.ui.Container
  - - com.codename1.ui.html.HTMLComponent

All Implemented Interfaces:

Animation, Editable, ActionListener, StyleListener, IOCallback, Iterable<Component>

Deprecated.
this component includes some customizability advantages but its probably better for 99% of the use cases to use the WebBrowser Component from the Components package. That component works with the native browser when applicable which is a far superior approach.
```
public class HTMLComponent
extends Container
implements ActionListener, IOCallback
```
HTMLComponent is a Codename One Component that renders HTML documents that conform to the XHTML Mobile Profile 1.0

Constructor Summary

Constructors
Constructor and Description

HTMLComponent()
Deprecated.

Constructs HTMLComponent

HTMLComponent(DocumentRequestHandler handler)
Deprecated.

Constructs HTMLComponent

Constructors
Constructor and Description
`HTMLComponent()` Deprecated. Constructs HTMLComponent
`HTMLComponent(DocumentRequestHandler handler)` Deprecated. Constructs HTMLComponent

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent evt)` Deprecated. {Invoked when an action occurred on a component}
`void`	`addCharEntitiesRange(String[] symbols, int startcode)` Deprecated. Adds the given symbols array to the user defined char entities table with the startcode provided as the code of the first string, startcode+1 for the second etc.
`void`	`addCharEntity(String symbol, int code)` Deprecated. Adds the given symbol and code to the user defined char entities table.
`static void`	`addFont(String fontKey, Font font)` Deprecated. Sets the given Codename One font for use with HTMLComponents.
`static void`	`addSpecialKey(String specialKeyName, int specialKeyCode)` Deprecated. Adds support for a special key to be used as an accesskey.
`boolean`	`animate()` Deprecated. Allows the animation to reduce "repaint" calls when it returns false.
`void`	`cancel()` Deprecated. Cancels the loading of the current page
`protected void`	`deinitialize()` Deprecated. If the component is taken off for any reason, makes sure access keys are not active
`DocumentInfo`	`getDocumentInfo()` Deprecated. Returns the DocumentInfo that currently represents the document loaded/shown
`HTMLElement`	`getDOM()` Deprecated. Returns the DOM representing this document
`HTMLCallback`	`getHTMLCallback()` Deprecated. Returns the HTMLCallback that is set on this HTMLComponent
`int`	`getPageStatus()` Deprecated. Returns the page status
`String`	`getPageURL()` Deprecated. Returns the page's URL
`String[]`	`getPropertyNames()` Deprecated. A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code
`Class[]`	`getPropertyTypes()` Deprecated. Matches the property names method (see that method for further details).
`Object`	`getPropertyValue(String name)` Deprecated. Returns the current value of the property name, this method is used by the GUI builder
`DocumentRequestHandler`	`getRequestHandler()` Deprecated. Returns the document request handler
`String`	`getTitle()` Deprecated. Returns the HTML page's title as described in its TITLE tag
`protected void`	`initComponent()` Deprecated. Overrides initComponent to add the key listeners to the access keys when the component is first added to the form/displayed This is useful when the component is added only after the page was read
`boolean`	`isEventsEnabled()` Deprecated. Returns the current status of the events enabled flag
`boolean`	`isSupressExceptions()` Deprecated.
`void`	`layoutContainer()` Deprecated. {Performs the layout of the container if a layout is necessary}
`void`	`refreshDOM()` Deprecated. Refreshes the current DOM so it any changes done after loading will be rendered.
`void`	`scrollPages(int pages, boolean animate)` Deprecated. Scrolls the HTMLComponent several pages forward/backward.
`void`	`scrollPixels(int pixels, boolean animate)` Deprecated. Scrolls the HTMLComponent several pixels forward/backward.
`void`	`scrollToElement(HTMLElement element, boolean animate)` Deprecated. Scrolls the HTMLComponent to the specified element
`void`	`setAutoFocusOnFirstLink(boolean autoFocus)` Deprecated. Determines whether to auto-focus on the first link after page load Note that focusing will happen only if the link is within a visible range (no scrolling is performed since this is rarely a wanted behaviour in this case)
`void`	`setBodyText(String htmlText)` Deprecated. Sets the given string containing HTML code as this HTMLComponent's body
`boolean`	`setBodyText(String htmlText, String encoding)` Deprecated. Sets the given string containing HTML code as this HTMLComponent's body.
`static void`	`setCSSSupportedMediaTypes(String[] supportedMediaTypes)` Deprecated. Sets the supported CSS media types to the given strings.
`void`	`setDefaultFont(String fontKey, Font font)` Deprecated. Sets the default font for this HTMLComponent
`void`	`setDOM(HTMLElement dom)` Deprecated. Sets this HTMLComponent to render the document in the specified DOM.
`void`	`setDOM(HTMLElement dom, String baseURL)` Deprecated. Sets this HTMLComponent to render the document in the specified DOM
`void`	`setEventsEnabled(boolean enabled)` Deprecated. Sets whether the active controls in the HTML will trigger events, and whether the DOM will change dynamically due to user input.
`boolean`	`setHTML(String htmlText, String encoding, String title, boolean isFullHTML)` Deprecated. Sets the given string containing HTML code either as this HTMLComponent's body or as the full HTML.
`void`	`setHTMLCallback(HTMLCallback callback)` Deprecated. Sets an HTMLCallback to listen to this HTMLCOmponent
`void`	`setIgnoreCSS(boolean ignore)` Deprecated. Sets whether this HTMLComponent will ignore all CSS.directives.
`static void`	`setMaxThreads(int threadsNum)` Deprecated. Sets the maximum number of threads to use for image download
`void`	`setPage(String pageURL)` Deprecated. Sets this HTMLComponent to render the document in the specified URL
`void`	`setPageStyle(Style pageStyle)` Deprecated. Sets the style of the page, allowing for example to set transparency to the main page.
`void`	`setPageUIID(String pageUIID)` Deprecated. Sets the UIID of the page (the internal container) This applies not only to the current page, but rather to all pages created with this HTMLComponent instance.
`void`	`setParser(HTMLParser parser)` Deprecated. Sets a custom HTMLParser for this HTMLComponent By default, a new HTMLParser instance is created for each HTMLComponent, use this method if you have a custom parser.
`String`	`setPropertyValue(String name, Object value)` Deprecated. Sets a new value to the given property, returns an error message if failed and null if successful.
`void`	`setRequestHandler(DocumentRequestHandler handler)` Deprecated. Changes the document request handler
`void`	`setShowImages(boolean show)` Deprecated. Sets whether this HTMLComponent will download and show linked images or not
`void`	`setSupressExceptions(boolean supressExceptions)` Deprecated.
`void`	`streamReady(InputStream is, DocumentInfo docInfo)` Deprecated. This method should be called only by AsyncDocumentRequestHandler implementations after an async fetch of a document

Methods inherited from class com.codename1.ui.Container
add, add, add, add, add, add, addAll, addComponent, addComponent, addComponent, addComponent, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, constrainHeightWhenScrollable, constrainWidthWhenScrollable, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getChildrenAsList, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayout, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getResponderAt, getSafeAreaRoot, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isSafeArea, isSafeAreaRoot, isScrollableX, isScrollableY, isSelectableInteraction, isSurface, iterator, iterator, keyPressed, keyReleased, morph, morphAndWait, paint, paintBackground, paintBorderBackground, paintComponentBackground, paintGlass, paramString, pointerPressed, refreshTheme, removeAll, removeComponent, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, revalidateLater, revalidateWithAnimationSafety, scrollComponentToVisible, setCellRenderer, setEnabled, setLayout, setLeadComponent, setSafeArea, setSafeAreaRoot, setScrollable, setScrollableX, setScrollableY, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager, updateTabIndices

Methods inherited from class com.codename1.ui.Component
addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, getEditingDelegate, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getPropertyTypeNames, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, initUnselectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, isRippleEffect, isRTL, isScrollable, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPinchBlocksDragAndDrop, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HTMLComponent
```
public HTMLComponent()
```
    Deprecated.
    
    Constructs HTMLComponent
  - HTMLComponent
```
public HTMLComponent(DocumentRequestHandler handler)
```
    Deprecated.
    
    Constructs HTMLComponent
    
    Parameters:
    
    handler - The HttpRequestHandler to which all requests for links will be sent
- Method Detail
  - addFont
```
public static void addFont(String fontKey,
                           Font font)
```
    Deprecated.
    
    Sets the given Codename One font for use with HTMLComponents. The font key can contain information about the following attributes: * The font family - i.e. Arial, Times New Roman etc. * The font size - in pixels (i.e. 12, 14 etc.) * The font style - bold, italic or both (no need to specify plain) * The font tag assignments - if this font should be used for any HTML specific tags they should be specified - i.e. h1, kbd etc. The key is just a concatenation of all attributes seperated with a dot. Examples for valid keys: arial.12 - Describes a plain font from the arial family in size 12 arial.16.bold - A bold arial font in size 16 courier.italic.bold.20 - A bold and italic courier font in size 20 arial.20.h1 - A plain arial font, size 20, that should be used for contents of the H1 tag code.kbd.samp - A font that should be used for the CODE, KBD and SAMP tags Note that the order of the attributes is not important and also that the case is ignored. This means that arial.12.bold.italic.h3 is equivalent to itALIc.H3.arial.BOLD.12 Also note that while you do not have to provide all the info for the font, but the info helps the rendering engine to reuse fonts when suitable. For example, if you have a 16px arial bold font which you want to use for H2, you can simply add it as "h2", but if you add it as "arial.16.bold.h2" then if the current font is arial.16 and the renderer encounters a B tag, it will know it can use the font you added as the bold counterpart of the current font. When adding system fonts there is no need to describe the font, the usage of setFont with system fonts is usually just to assign them for tags. The rendering engine knows to derive bold/italic/bigger/smaller fonts from other system fonts (default or tag fonts) even if not added.
    
    Parameters:
    
    fontKey - The font key in the format described above
    
    font - The actual Codename One font object
  - setParser
```
public void setParser(HTMLParser parser)
```
    Deprecated.
    
    Sets a custom HTMLParser for this HTMLComponent By default, a new HTMLParser instance is created for each HTMLComponent, use this method if you have a custom parser.
    
    Parameters:
    
    parser - The HTMLParser to use
  - addCharEntity
```
public void addCharEntity(String symbol,
                          int code)
```
    Deprecated.
    
    Adds the given symbol and code to the user defined char entities table. Symbols do not need to include leading & and trailing ; - these will be trimmed if given as the symbol
    
    Parameters:
    
    symbol - The symbol to add
    
    code - The symbol's code
  - addSpecialKey
```
public static void addSpecialKey(String specialKeyName,
                                 int specialKeyCode)
```
    Deprecated.
    
    Adds support for a special key to be used as an accesskey. The CSS property -wap-accesskey supports special keys, for example "phone-send" that may have different key codes per device. This method allows pairing between such keys to their respective key codes. Note that these keys are valid only for -wap-aceesskey in CSS files, and not for the XHTML accesskey attribute.
    
    Parameters:
    
    specialKeyName - The name of the special key as denoted in CSS files
    
    specialKeyCode - The special key code
  - addCharEntitiesRange
```
public void addCharEntitiesRange(String[] symbols,
                                 int startcode)
```
    Deprecated.
    
    Adds the given symbols array to the user defined char entities table with the startcode provided as the code of the first string, startcode+1 for the second etc. Some strings in the symbols array may be null thus skipping code numbers.
    
    Parameters:
    
    symbols - The symbols to add
    
    startcode - The symbol's code
  - setMaxThreads
```
public static void setMaxThreads(int threadsNum)
```
    Deprecated.
    
    Sets the maximum number of threads to use for image download
    
    Parameters:
    
    threadsNum - the maximum number of threads to use for image download
  - setCSSSupportedMediaTypes
```
public static void setCSSSupportedMediaTypes(String[] supportedMediaTypes)
```
    Deprecated.
    
    Sets the supported CSS media types to the given strings. Usually the default media types ("all","handheld") should be suitable, but in case this runs on a device that matches another profile, the developer can specify it here.
    
    Parameters:
    
    supportedMediaTypes - A string array containing the media types that should be supported
  - getRequestHandler
```
public DocumentRequestHandler getRequestHandler()
```
    Deprecated.
    
    Returns the document request handler
    
    Returns:
    
    the document request handler
  - setRequestHandler
```
public void setRequestHandler(DocumentRequestHandler handler)
```
    Deprecated.
    
    Changes the document request handler
    
    Parameters:
    
    handler - the new document request handler
  - getDocumentInfo
```
public DocumentInfo getDocumentInfo()
```
    Deprecated.
    
    Returns the DocumentInfo that currently represents the document loaded/shown
    
    Returns:
    
    the DocumentInfo that currently represents the document loaded/shown
  - setHTMLCallback
```
public void setHTMLCallback(HTMLCallback callback)
```
    Deprecated.
    
    Sets an HTMLCallback to listen to this HTMLCOmponent
    
    Parameters:
    
    callback - The HTMLCallback that will receive events
  - getHTMLCallback
```
public HTMLCallback getHTMLCallback()
```
    Deprecated.
    
    Returns the HTMLCallback that is set on this HTMLComponent
    
    Returns:
    
    the HTMLCallback that is set on this HTMLComponent or null if none
  - setDefaultFont
```
public void setDefaultFont(String fontKey,
                           Font font)
```
    Deprecated.
    
    Sets the default font for this HTMLComponent
    
    Parameters:
    
    fontKey - The font key in the format described in setFont (Can be null for default font, but it is recommended to add a descriptive key if this is a bitmap font to enable the font engine to use it in other cases as well)
    
    font - The actual Codename One font object
  - setShowImages
```
public void setShowImages(boolean show)
```
    Deprecated.
    
    Sets whether this HTMLComponent will download and show linked images or not
    
    Parameters:
    
    show - true to show images, false otherwise
  - setIgnoreCSS
```
public void setIgnoreCSS(boolean ignore)
```
    Deprecated.
    
    Sets whether this HTMLComponent will ignore all CSS.directives. This includes external CSS files (which won't be downloaded), embedded CSS segmentsand style tags and attributes. By default this is false.
    
    Parameters:
    
    ignore - true to ignore CSS directives, false otherwise
  - scrollPixels
```
public void scrollPixels(int pixels,
                         boolean animate)
```
    Deprecated.
    
    Scrolls the HTMLComponent several pixels forward/backward.
    
    Parameters:
    
    pixels - The number of pixels to scroll (positive for forward and negative for backward)
    
    animate - true to animate the scrolling, false otherwise
  - scrollPages
```
public void scrollPages(int pages,
                        boolean animate)
```
    Deprecated.
    
    Scrolls the HTMLComponent several pages forward/backward. TO scroll to the start or end of the document, one can provide a very big number.
    
    Parameters:
    
    pages - The number of pages to scroll (positive for forward and negative for backward)
    
    animate - true to animate the scrolling, false otherwise
  - scrollToElement
```
public void scrollToElement(HTMLElement element,
                            boolean animate)
```
    Deprecated.
    
    Scrolls the HTMLComponent to the specified element
    
    Parameters:
    
    element - The element to scroll to (must be contained in the document)
    
    animate - true to animate the scrolling, false otherwise
    
    Throws:
    
    IllegalArgumentException - if the element is not contained in the current document.
  - setBodyText
```
public void setBodyText(String htmlText)
```
    Deprecated.
    
    Sets the given string containing HTML code as this HTMLComponent's body
    
    Parameters:
    
    htmlText - The HTML body to set
  - setBodyText
```
public boolean setBodyText(String htmlText,
                           String encoding)
```
    Deprecated.
    
    Sets the given string containing HTML code as this HTMLComponent's body. The string is read using the specified encoding. If the encoding is not supported it will be read without encoding
    
    Parameters:
    
    htmlText - The HTML body to set
    
    encoding - The encoding to use when reading the HTML i.e. UTF8, ISO-8859-1 etc.
    
    Returns:
    
    true if the encoding succeeded, false otherwise
  - setHTML
```
public boolean setHTML(String htmlText,
                       String encoding,
                       String title,
                       boolean isFullHTML)
```
    Deprecated.
    
    Sets the given string containing HTML code either as this HTMLComponent's body or as the full HTML. The string is read using the specified encoding. If the encoding is not supported it will be read without encoding
    
    Parameters:
    
    htmlText - The HTML to set
    
    encoding - The encoding to use when reading the HTML i.e. UTF8, ISO-8859-1 etc.
    
    title - The HTML title, or null if none (Used only when isFullHTML is false)
    
    isFullHTML - true if this is a full HTML document (with html/body tags), false if this HTML should be used as the HTMLComponent's body
    
    Returns:
    
    true if the encoding succeeded, false otherwise
  - cancel
```
public void cancel()
```
    Deprecated.
    
    Cancels the loading of the current page
  - setPage
```
public void setPage(String pageURL)
```
    Deprecated.
    
    Sets this HTMLComponent to render the document in the specified URL
    
    Parameters:
    
    pageURL - The URL containing the HTML document
  - setPageStyle
```
public void setPageStyle(Style pageStyle)
```
    Deprecated.
    
    Sets the style of the page, allowing for example to set transparency to the main page. This applies not only to the current page, but rather to all pages created with this HTMLComponent instance. If both a UIID and a pageStyle were set, the style overrides the UIID.
    
    Parameters:
    
    pageStyle - The style to set to the page
  - setPageUIID
```
public void setPageUIID(String pageUIID)
```
    Deprecated.
    
    Sets the UIID of the page (the internal container) This applies not only to the current page, but rather to all pages created with this HTMLComponent instance. If both a UIID and a pageStyle were set, the style overrides the UIID.
    
    Parameters:
    
    pageUIID - The UIID that should be applied to the page
  - streamReady
```
public void streamReady(InputStream is,
                        DocumentInfo docInfo)
```
    Deprecated.
    
    This method should be called only by AsyncDocumentRequestHandler implementations after an async fetch of a document
    
    Specified by:
    
    streamReady in interface IOCallback
    
    Parameters:
    
    is - The InputStream of the document
    
    docInfo - The document info
  - setDOM
```
public void setDOM(HTMLElement dom)
```
    Deprecated.
    
    Sets this HTMLComponent to render the document in the specified DOM. Note that relative links if any will be disabled. To allow relative links with DOM use setDOM(HTMLElement dom,String baseURL)
    
    Parameters:
    
    dom - An HTMLElement representing the root of the HTML document
    
    Throws:
    
    IllegalArgumentException - if the HTMLElement supplied is not an 'html' tag
  - setDOM
```
public void setDOM(HTMLElement dom,
                   String baseURL)
```
    Deprecated.
    
    Sets this HTMLComponent to render the document in the specified DOM
    
    Parameters:
    
    dom - An HTMLElement representing the root of the HTML document
    
    baseURL - The base URL for this DOM (Necessary if document references relative links)
    
    Throws:
    
    IllegalArgumentException - if the HTMLElement supplied is not an 'html' tag
  - getDOM
```
public HTMLElement getDOM()
```
    Deprecated.
    
    Returns the DOM representing this document
    
    Returns:
    
    An HTMLElement representing the entire current HTML document
    
    Throws:
    
    IllegalStateException - if the page is still loading
  - refreshDOM
```
public void refreshDOM()
```
    Deprecated.
    
    Refreshes the current DOM so it any changes done after loading will be rendered.
  - setEventsEnabled
```
public void setEventsEnabled(boolean enabled)
```
    Deprecated.
    
    Sets whether the active controls in the HTML will trigger events, and whether the DOM will change dynamically due to user input. If so the events are dispatched via HTMLCallback methods actionPerformed, focusGained/Lost, selectionChanged and dataChanged The default is false in order not to add more overhead if these are not needed.
    
    Parameters:
    
    enabled - true to enable event dispatching, false otherwise
  - isEventsEnabled
```
public boolean isEventsEnabled()
```
    Deprecated.
    
    Returns the current status of the events enabled flag
    
    Returns:
    
    true if events are enabled, false if not
  - setAutoFocusOnFirstLink
```
public void setAutoFocusOnFirstLink(boolean autoFocus)
```
    Deprecated.
    
    Determines whether to auto-focus on the first link after page load Note that focusing will happen only if the link is within a visible range (no scrolling is performed since this is rarely a wanted behaviour in this case)
    
    Parameters:
    
    autoFocus - true to auto-focus, false otherwise
  - animate
```
public boolean animate()
```
    Deprecated.
    
    Description copied from class: Component
    
    Allows the animation to reduce "repaint" calls when it returns false. It is called once for every frame. Frames are defined by the Display class.
    
    Specified by:
    
    animate in interface Animation
    
    Overrides:
    
    animate in class Component
    
    Returns:
    
    true if a repaint is desired or false if no repaint is necessary
  - getTitle
```
public String getTitle()
```
    Deprecated.
    
    Returns the HTML page's title as described in its TITLE tag
    
    Returns:
    
    the HTML page's title as described in its TITLE tag
  - getPageURL
```
public String getPageURL()
```
    Deprecated.
    
    Returns the page's URL
    
    Returns:
    
    the current page's URL
  - getPageStatus
```
public int getPageStatus()
```
    Deprecated.
    
    Returns the page status
    
    Returns:
    
    the page status (One of the STATUS_* constants in HTMLCallback)
  - initComponent
```
protected void initComponent()
```
    Deprecated.
    
    Overrides initComponent to add the key listeners to the access keys when the component is first added to the form/displayed This is useful when the component is added only after the page was read
    
    Overrides:
    
    initComponent in class Component
  - deinitialize
```
protected void deinitialize()
```
    Deprecated.
    
    If the component is taken off for any reason, makes sure access keys are not active
    
    Overrides:
    
    deinitialize in class Component
  - layoutContainer
```
public void layoutContainer()
```
    Deprecated.
    
    {Performs the layout of the container if a layout is necessary}
    
    Overrides:
    
    layoutContainer in class Container
  - actionPerformed
```
public void actionPerformed(ActionEvent evt)
```
    Deprecated.
    
    {Invoked when an action occurred on a component}
    
    Specified by:
    
    actionPerformed in interface ActionListener
    
    Parameters:
    
    evt - event object describing the source of the action as well as its trigger
  - getPropertyNames
```
public String[] getPropertyNames()
```
    Deprecated.
    
    A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code
    
    Overrides:
    
    getPropertyNames in class Component
    
    Returns:
    
    the property names allowing mutation
  - getPropertyTypes
```
public Class[] getPropertyTypes()
```
    Deprecated.
    
    Matches the property names method (see that method for further details).
    
    Overrides:
    
    getPropertyTypes in class Component
    
    Returns:
    
    the types of the properties
  - getPropertyValue
```
public Object getPropertyValue(String name)
```
    Deprecated.
    
    Returns the current value of the property name, this method is used by the GUI builder
    
    Overrides:
    
    getPropertyValue in class Component
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the value of said property
  - setPropertyValue
```
public String setPropertyValue(String name,
                               Object value)
```
    Deprecated.
    
    Sets a new value to the given property, returns an error message if failed and null if successful. Notice that some builtin properties such as "$designMode" might be sent to components to indicate application state.
    
    Overrides:
    
    setPropertyValue in class Component
    
    Parameters:
    
    name - the name of the property
    
    value - new value for the property
    
    Returns:
    
    error message or null
  - isSupressExceptions
```
public boolean isSupressExceptions()
```
    Deprecated.
    
    Returns:
    
    the supressExceptions
  - setSupressExceptions
```
public void setSupressExceptions(boolean supressExceptions)
```
    Deprecated.
    
    Parameters:
    
    supressExceptions - the supressExceptions to set

Class HTMLComponent

Field Summary

Fields inherited from class com.codename1.ui.Component

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.Container

Methods inherited from class com.codename1.ui.Component

Methods inherited from class java.lang.Object

Constructor Detail

HTMLComponent

HTMLComponent

Method Detail

addFont

setParser

addCharEntity

addSpecialKey

addCharEntitiesRange

setMaxThreads

setCSSSupportedMediaTypes

getRequestHandler

setRequestHandler

getDocumentInfo

setHTMLCallback

getHTMLCallback

setDefaultFont

setShowImages

setIgnoreCSS

scrollPixels

scrollPages

scrollToElement

setBodyText

setBodyText

setHTML

cancel

setPage

setPageStyle

setPageUIID

streamReady

setDOM

setDOM

getDOM

refreshDOM

setEventsEnabled

isEventsEnabled

setAutoFocusOnFirstLink

animate

getTitle

getPageURL

getPageStatus

initComponent

deinitialize

layoutContainer

actionPerformed

getPropertyNames

getPropertyTypes

getPropertyValue

setPropertyValue

isSupressExceptions

setSupressExceptions