Package org.dwcj.controls.htmlcontainer

Class HtmlContainer

java.lang.Object

org.dwcj.controls.AbstractControl

org.dwcj.controls.AbstractDwcControl

org.dwcj.controls.htmlcontainer.HtmlContainer

All Implemented Interfaces:

Control, Enableable, Focusable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasStyle, HasTooltip, HasVisibility, TabTraversable

public final class HtmlContainer
extends AbstractDwcControl
implements Focusable, TabTraversable

A HtmlContainer control

Field Summary

Fields inherited from class org.dwcj.controls.AbstractDwcControl

BASISNUMBER_1, BASISNUMBER_25, BASISNUMBER_250, focusable, horizontalScrollBarPosition, mouseWheelCondition, readOnly, STR_EXPANSE, STR_THEME, tabTraversable, textAlignment, textHighlight, verticalScrollBarPosition

Fields inherited from class org.dwcj.controls.AbstractControl

ctrl, destroyed, elementId, userData

Constructor Summary

Constructors

Constructor	Description
HtmlContainer()
HtmlContainer(String text)

Method Summary

Modifier and Type	Method	Description
HtmlContainer	addClassName(String selector)	Adds a CSS class to the list of CSS classes for the control.
protected void	catchUp()	The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation.
protected void	create(AbstractDwcjPanel p)	Create the object on a panel p.
void	executeAsyncScript(String script)
Object	executeScript(String script)
String	getClientType()
String	getClientVersion()
Image	getImage()
String	getText()	get the text property of the control
String	getUrl()
String	getUserAgent()
HtmlContainer	injectScript(String script)
HtmlContainer	injectScript(String script, Boolean top)
HtmlContainer	injectUrl(String url)
HtmlContainer	injectUrl(String url, Boolean top)
Boolean	isAutoNavigate()
Boolean	isFocusable()	isFocusable returns a value indicating whether or not the user can focus the control.
Boolean	isTabTraversable()	Returns a boolean indicating whether or not the user can navigate to the control using the tab key.
HtmlContainer	onJavascriptEvent(Consumer<HtmlContainerJavascriptEvent> callback)	register a callback method to be called from JavaScript with basisDispatchNativeEvent see BBjNativeJavaScriptEvent
HtmlContainer	onPageLoaded(Consumer<HtmlContainerPageLoadedEvent> callback)	register a callback method to be called after the page loaded event in the htmlcontainer is reached
HtmlContainer	onScriptFailed(Consumer<HtmlContainerOnScriptFailedEvent> callback)
HtmlContainer	onScriptLoaded(Consumer<HtmlContainerOnScriptLoadedEvent> callback)
Boolean	print()
HtmlContainer	removeClassName(String selector)	Removes a CSS class from the list of CSS classes for the control.
HtmlContainer	setAttribute(String attribute, String value)	set the value for an attribute in the control
HtmlContainer	setAutoNavigate(Boolean autoNavigate)
HtmlContainer	setDownloadDirectory(String downloadDir)
HtmlContainer	setEnabled(Boolean enabled)	Set whether the control is to be enabled
HtmlContainer	setFocusable(Boolean focusable)	setFocusable sets whether a control can be focused.
HtmlContainer	setId(String elementId)	Assigns the ID of a control
HtmlContainer	setStyle(String property, String value)	Assigns specified value to the specified CSS property
HtmlContainer	setTabTraversable(Boolean traversable)	Sets whether or not the user can navigate to the control using the tab key.
HtmlContainer	setText(String text)	set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all
HtmlContainer	setTooltipText(String text)	Set the tooltip text of the control
HtmlContainer	setUrl(String url)
HtmlContainer	setUrl(String url, Boolean reload)
HtmlContainer	setUserAgent(String userAgent)
HtmlContainer	setVisible(Boolean visible)	Set whether the control is visible or invisible

Methods inherited from class org.dwcj.controls.AbstractDwcControl

destroy, getAttribute, getComputedStyle, getTooltipText, isEnabled, isVisible, setControlExpanse, setControlTheme

Methods inherited from class org.dwcj.controls.AbstractControl

getCaughtUp, getId, getUserData, isDestroyed, setUserData

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlContainer

public HtmlContainer()

HtmlContainer

public HtmlContainer(String text)

Method Details

create

protected void create(AbstractDwcjPanel p)

Description copied from class: AbstractControl

Create the object on a panel p. The preferred way of creating an object is using the Panel::add(Control) method, instead of this

Overrides:

create in class AbstractControl

Parameters:

p - the panel to add this control on

onScriptLoaded

public HtmlContainer onScriptLoaded(Consumer<HtmlContainerOnScriptLoadedEvent> callback)

onScriptFailed

public HtmlContainer onScriptFailed(Consumer<HtmlContainerOnScriptFailedEvent> callback)

executeAsyncScript

public void executeAsyncScript(String script)

executeScript

public Object executeScript(String script)

isAutoNavigate

public Boolean isAutoNavigate()

getClientType

public String getClientType()

getClientVersion

public String getClientVersion()

getImage

public Image getImage()

getText

public String getText()

Description copied from interface: HasControlText

get the text property of the control

Specified by:

getText in interface HasControlText

Overrides:

getText in class AbstractDwcControl

Returns:

the text

getUrl

public String getUrl()

getUserAgent

public String getUserAgent()

injectScript

public HtmlContainer injectScript(String script)

injectScript

public HtmlContainer injectScript(String script,
 Boolean top)

injectUrl

public HtmlContainer injectUrl(String url)

injectUrl

public HtmlContainer injectUrl(String url,
 Boolean top)

print

public Boolean print()

setAutoNavigate

public HtmlContainer setAutoNavigate(Boolean autoNavigate)

setDownloadDirectory

public HtmlContainer setDownloadDirectory(String downloadDir)

setUrl

public HtmlContainer setUrl(String url)

setUrl

public HtmlContainer setUrl(String url,
 Boolean reload)

setUserAgent

public HtmlContainer setUserAgent(String userAgent)

onPageLoaded

public HtmlContainer onPageLoaded(Consumer<HtmlContainerPageLoadedEvent> callback)

register a callback method to be called after the page loaded event in the htmlcontainer is reached

Parameters:

callback - the callback method

Returns:

the control itself

onJavascriptEvent

public HtmlContainer onJavascriptEvent(Consumer<HtmlContainerJavascriptEvent> callback)

register a callback method to be called from JavaScript with basisDispatchNativeEvent see BBjNativeJavaScriptEvent

Parameters:

callback - the callback method

Returns:

the control itself

isFocusable

public Boolean isFocusable()

Description copied from interface: Focusable

isFocusable returns a value indicating whether or not the user can focus the control. Note: A focused control is the control to which keyboard interaction is directed. Typically, the focused control is indicated visually, often via a dotted grey border. A control which is not focusable, therefore, cannot be manipulated via the keyboard. It is still possible to interact with a non-focusable control via the mouse.

Specified by:

isFocusable in interface Focusable

Returns:

True if object can be focused, False if not.

setFocusable

public HtmlContainer setFocusable(Boolean focusable)

Description copied from interface: Focusable

setFocusable sets whether a control can be focused. Note: A focused control is the control to which keyboard interaction is directed. Typically, the focused control is indicated visually, often via a dotted grey border. A control which is not focusable, therefore, cannot be manipulated via the keyboard. It is still possible to interact with a non-focusable control via the mouse. To disable all interaction, including the mouse, see setEnabled() and setReadOnly().

Specified by:

setFocusable in interface Focusable

Parameters:

focusable - Boolean True for allowing focusing, False to disable focus

Returns:

Object itself

isTabTraversable

public Boolean isTabTraversable()

Description copied from interface: TabTraversable

Returns a boolean indicating whether or not the user can navigate to the control using the tab key.

Specified by:

isTabTraversable in interface TabTraversable

Returns:

True if user can navigate to control with Tab key, False if not

setTabTraversable

public HtmlContainer setTabTraversable(Boolean traversable)

Description copied from interface: TabTraversable

Sets whether or not the user can navigate to the control using the tab key.

Specified by:

setTabTraversable in interface TabTraversable

Parameters:

traversable - Boolean dictating tab traversal. True if control can be navigated to with Tab, False if not.

Returns:

The control itself

setText

public HtmlContainer setText(String text)

Description copied from interface: HasControlText

set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all

Specified by:

setText in interface HasControlText

Overrides:

setText in class AbstractDwcControl

Returns:

the control itself

setVisible

public HtmlContainer setVisible(Boolean visible)

Description copied from interface: HasVisibility

Set whether the control is visible or invisible

Specified by:

setVisible in interface HasVisibility

Overrides:

setVisible in class AbstractDwcControl

Returns:

the control itself

setEnabled

public HtmlContainer setEnabled(Boolean enabled)

Description copied from interface: Enableable

Set whether the control is to be enabled

Specified by:

setEnabled in interface Enableable

Overrides:

setEnabled in class AbstractDwcControl

Returns:

the control itself

setTooltipText

public HtmlContainer setTooltipText(String text)

Description copied from interface: HasTooltip

Set the tooltip text of the control

Specified by:

setTooltipText in interface HasTooltip

Overrides:

setTooltipText in class AbstractDwcControl

Returns:

the control itself

setAttribute

public HtmlContainer setAttribute(String attribute,
 String value)

Description copied from class: AbstractDwcControl

set the value for an attribute in the control

Specified by:

setAttribute in interface HasAttribute

Overrides:

setAttribute in class AbstractDwcControl

Parameters:

attribute - the name of the attribute

value - the value to be set

Returns:

the control itself

setId

public HtmlContainer setId(String elementId)

Description copied from interface: Control

Assigns the ID of a control

Specified by:

setId in interface Control

Overrides:

setId in class AbstractControl

Parameters:

elementId - Desired ID designation

Returns:

The control itself

setStyle

public HtmlContainer setStyle(String property,
 String value)

Description copied from interface: HasStyle

Assigns specified value to the specified CSS property

Specified by:

setStyle in interface HasStyle

Overrides:

setStyle in class AbstractDwcControl

Parameters:

property - The CSS property to be changed

value - The value of the selected CSS property

Returns:

The control itself

addClassName

public HtmlContainer addClassName(String selector)

Description copied from interface: HasClassName

Adds a CSS class to the list of CSS classes for the control.

Specified by:

addClassName in interface HasClassName

Overrides:

addClassName in class AbstractDwcControl

Returns:

The control itself

removeClassName

public HtmlContainer removeClassName(String selector)

Description copied from interface: HasClassName

Removes a CSS class from the list of CSS classes for the control.

Specified by:

removeClassName in interface HasClassName

Overrides:

removeClassName in class AbstractDwcControl

Returns:

The control itself

catchUp

protected void catchUp()
                throws IllegalAccessException

Description copied from class: AbstractDwcControl

The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation. A control is not created before it's added to a panel. Anything that is added between instantiation of a control and its addition to a panel has to be recorded and replayed in this method

Overrides:

catchUp in class AbstractDwcControl

Throws:

IllegalAccessException - - thrown if an attempt is made to call this method more than once