com.codename1.components

Class WebBrowser

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.Container

com.codename1.components.WebBrowser

All Implemented Interfaces:

Animation, Editable, StyleListener, Iterable<Component>

Deprecated.

UseBrowserComponent instead. The original purpose of this class was to work as an interim solution for platforms where BrowserComponent isn't supported however all currently supported platforms work with BrowserComponent so there is no real reason to use this class

public class WebBrowser
extends Container

A simple browser view that encapsulates a usable version of HTMLComponent or BrowserComponent and automatically picks the right component for the platform preferring BrowserComponent whenever it is supported.

On Android this component might show a native progress indicator dialog. You can disable that functionality using the call.

Field Summary

Fields inherited from class com.codename1.ui.Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR

Constructor Summary

Constructors

Constructor and Description
WebBrowser() Deprecated. Default constructor
WebBrowser(String url) Deprecated. Constructor with a URL

Method Summary

Modifier and Type	Method and Description
static String	createDataURI(byte[] data, String mime) Deprecated. This method creates a data URI which allows developers creating HTML for local use to embed local images into the HTML by appending them as a URI.
void	destroy() Deprecated. Release WebBrowser native resources.
BrowserNavigationCallback	getBrowserNavigationCallback() Deprecated. The browser navigation callback interface allows handling a case where a URL invocation can be delegated to Java code.
Component	getInternal() Deprecated. Since the internal component can be either an HTMLComponent or a BrowserComponent one of them will be returned.
String	getPage() Deprecated. Returns the page set by getPage for the GUI builder
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
String[]	getPropertyTypeNames() Deprecated. This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer
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
String	getTitle() Deprecated. Returns the title for the browser page
String	getURL() Deprecated. The page URL
void	onError(String message, int errorCode) Deprecated. This is a callback method to inform on an error.
void	onLoad(String url) Deprecated. This is a callback method, this method is called after the url has been loaded
void	onStart(String url) Deprecated. This is a callback method, this method is called before the url has been loaded
void	reload() Deprecated. Reload the current page
void	setBrowserNavigationCallback(BrowserNavigationCallback callback) Deprecated. Set the browser navigation callback which allows handling a case where a URL invocation can be delegated to Java code.
void	setPage(String html, String baseUrl) Deprecated. Shows the given HTML in the native viewer
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	setURL(String url) Deprecated. Sets the page URL, jar: URL's must be supported by the implementation
void	stop() Deprecated. Stop loading the current page

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, layoutContainer, 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, animate, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitialize, 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, 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, initComponent, 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

WebBrowser

public WebBrowser(String url)

Deprecated.

Constructor with a URL

Parameters:

url - the url

WebBrowser

public WebBrowser()

Deprecated.

Default constructor

Method Detail

createDataURI

public static String createDataURI(byte[] data,
                                   String mime)

Deprecated.

This method creates a data URI which allows developers creating HTML for local use to embed local images into the HTML by appending them as a URI. E.g. instead of referencing a file or URL just load the image data and place the contents of this string into the src attribute.

This is the easiest way to get an HTML with local images to work on all mobile platforms.

Parameters:

data - data of an image

mime - the mime type of the image e.g. image/png

Returns:

a data URL that can be placed into the img src attribute in HTML e.g. data:image/png;base64,encodedData

onStart

public void onStart(String url)

Deprecated.

This is a callback method, this method is called before the url has been loaded

Parameters:

url -

onLoad

public void onLoad(String url)

Deprecated.

This is a callback method, this method is called after the url has been loaded

Parameters:

url -

setBrowserNavigationCallback

public void setBrowserNavigationCallback(BrowserNavigationCallback callback)

Deprecated.

Set the browser navigation callback which allows handling a case where a URL invocation can be delegated to Java code. This allows binding Java side functionality to JavaScript functionality in the same way PhoneGap/Cordova work

Parameters:

callback - the callback interface

getBrowserNavigationCallback

public BrowserNavigationCallback getBrowserNavigationCallback()

Deprecated.

The browser navigation callback interface allows handling a case where a URL invocation can be delegated to Java code. This allows binding Java side functionality to JavaScript functionality in the same way PhoneGap/Cordova work

Returns:

the callback interface

onError

public void onError(String message,
                    int errorCode)

Deprecated.

This is a callback method to inform on an error.

Parameters:

message -

errorCode -

getInternal

public Component getInternal()

Deprecated.

Since the internal component can be either an HTMLComponent or a BrowserComponent one of them will be returned. If you are targeting modern smartphones only you can rely on this method returning a BrowserComponent instance.

Returns:

BrowserComponent or HTMLComponent

getTitle

public String getTitle()

Deprecated.

Returns the title for the browser page

Returns:

the title

getURL

public String getURL()

Deprecated.

The page URL

Returns:

the URL

setURL

public void setURL(String url)

Deprecated.

Sets the page URL, jar: URL's must be supported by the implementation

Parameters:

url - the URL

reload

public void reload()

Deprecated.

Reload the current page

stop

public void stop()

Deprecated.

Stop loading the current page

destroy

public void destroy()

Deprecated.

Release WebBrowser native resources.

setPage

public void setPage(String html,
                    String baseUrl)

Deprecated.

Shows the given HTML in the native viewer

Parameters:

html - HTML web page

baseUrl - base URL to associate with the HTML

getPage

public String getPage()

Deprecated.

Returns the page set by getPage for the GUI builder

Returns:

the HTML page set manually

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

getPropertyTypeNames

public String[] getPropertyTypeNames()

Deprecated.

This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer

Overrides:

getPropertyTypeNames in class Component

Returns:

Array of type names

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