public class BrowserComponent

String constant for web event listener. Use this event types to register to receive messages in a cross-domain-safe way from the web page. To send a message from the webpage, the page should include a function like:

`function postToCN1(msg) {
if (window.cn1PostMessage) {
// Case 1: Running inside native app in a WebView
window.cn1PostMessage(msg);` else {
// Case 2: Running inside a Javascript app in an iframe
window.parent.postMessage(msg, '*');
}
  }
}

Receiving a message:

`myBrowserComponent.addWebEventListener(BrowserComponent.onMessage, e->{
CN.callSerially(()->{
Log.p("Message: "+e.getSource());
Dialog.show("Here", (String)e.getSource(), "OK", null);`);
  });
}

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.

Calls the postMessage() method on the webpage’s window object.

This is useful mainly for the Javascript port so that you don’t have to worry about cross-domain issues, as postMessage() is supported cross-domain.

To receive a message, the web page should register a “message” event listener, just as it would to receive messages from other windows in the browser. See MDN docs for postMessage() for more information.

Executes the given JavaScript and returns a result string from the underlying platform where applicable.

Note: Some platforms use Display#invokeAndBlock(java.lang.Runnable) inside this method which is very costly. Try to avoid this synchronous method, and prefer to use one of the asynchronous versions. E.g. com.codename1.util.SuccessCallback)

Executes the given javascript and returns the result string from the underlying platform.

Note: Some platforms use Display#invokeAndBlock(java.lang.Runnable) inside this method which is very costly. Try to avoid this synchronous method, and prefer to use one of the asynchronous versions. E.g. com.codename1.util.SuccessCallback)

Asynchronously executes the provided javascript expression. The expression may provide a callback which you can call inside the expression directly.

Example

Getting the window object.

`bc.execute("callback.onSuccess(window)", value -> {
System.out.println("value="+value+"; type="+value.getJSType());
// value=[object Window]; type=OBJECT`);
}

Getting an Integer

`bc.execute("callback.onSuccess(1+2)", value -> {
System.out.println("value="+value.getInt()+"; type="+value.getJSType());
// value=3; type=NUMBER`);
}

Getting a String

`bc.execute("callback.onSuccess('hello world')",value -> {
System.out.println("value="+value+"; type="+value.getJSType());
// value=hello world; type=STRING`
);
}

After a Javascript Timeout

Since this call is asynchronous, the javascript code can wait to call the callback to any time in the future - e.g. after a timeout, after an ajax response, in some event handler, etc.. The CN1 UI will not be blocked, the provided callback will be called at the appropriate time on the EDT.

`bc.execute("setTimeout(function(){callback.onSuccess('hello world')`, 1500)",
value -> {
System.out.println("value="+value+"; type="+value.getJSType());
// value=hello world; type=STRING
}
);
}

NOTE: The callback can only be called once, so you shouldn’t use this method to register a callback with an event listener that will be called repeatedly. If you want to register a Java callback with a Javascript event, you should use the com.codename1.util.Callback) method instead.

Registers a Java method as a callback in javascript. The callback argument can be referenced inside the javascript expression so that it can be fired when certain events occur.

Examples

Register a Callback to be called whenever a button is clicked

`bc.addJSCallback("someButton.addEventListener('click', function(){callback.onSuccess('hello world')`)", new Callback() {
public void onSucess(JSRef value) {
System.out.println("Received click: "+value);
}
});
}

Removes a JS callback that was added via the com.codename1.util.SuccessCallback) method.

Note: This won’t unregister any callbacks from the Javascript environment. You’ll need to perform your own additional cleanup in Javascript if this callback is registered in any event handlers.

This uses invokeAndBlock to wait for the result of the given javascript expression. It is extremely important that the js expression calls either callback.onSuccess(value) or literalcallback.onError(message, code) at some point, or this method will never return.

#executeAndWait(java.lang.String) vs #executeAndReturnString(java.lang.String)

#executeAndReturnString(java.lang.String) is also blocking, but it uses javascript eval to return the value of the expression. Therefore it can’t return the result of any asynchronous operations.

#executeAndWait(java.lang.String) is built directly on top of com.codename1.util.SuccessCallback) which is fully asynchronous, and allows you to specify where and when you call the callback within the javascript code. This means that you must explicitly call either callback.onSuccess(value) or literalcallback.onError(message, code) at some point in the Javascript expression - or the method will block indefinitely.

This uses invokeAndBlock to wait for the result of the given javascript expression. It is extremely important that the js expression calls either callback.onSuccess(value) or literalcallback.onError(message, code) at some point, or this method will never return.

#executeAndWait(java.lang.String) vs #executeAndReturnString(java.lang.String)

#executeAndReturnString(java.lang.String) is also blocking, but it uses javascript eval to return the value of the expression. Therefore it can’t return the result of any asynchronous operations.

#executeAndWait(java.lang.String) is built directly on top of com.codename1.util.SuccessCallback) which is fully asynchronous, and allows you to specify where and when you call the callback within the javascript code. This means that you must explicitly call either callback.onSuccess(value) or literalcallback.onError(message, code) at some point in the Javascript expression - or the method will block indefinitely.

Sets a client property on this component. BrowserComponent supports several special client properties that control platform-specific behavior.

HTML5/JavaScript Port Client Properties

• HTML5Peer.removeOnDeinitialize (Boolean): Controls whether the underlying iframe is removed from the DOM when the component is deinitialized.

  When a Dialog is shown, the parent Form is deinitialized, which normally causes BrowserComponent’s iframe to be removed from the DOM. When the Dialog is dismissed, the Form is re-shown but the iframe must be recreated from scratch, losing all JavaScript state (editor content, event listeners, etc.).

  Setting this to Boolean.FALSE preserves the iframe in the DOM across deinitialization cycles, which is essential for:

  • WebRTC connections that break when removed from DOM
  • Editors and interactive components that need to preserve state
  • Any app that shows dialogs over a BrowserComponent

  Example:

  BrowserComponent browser = new BrowserComponent();
  browser.putClientProperty("HTML5Peer.removeOnDeinitialize", Boolean.FALSE);
  

• BrowserComponent.firebug (Boolean): Enables debug mode with Firebug console integration (development only).