Package org.dwcj.controls.textcombobox

Class TextComboBox

java.lang.Object

org.dwcj.controls.AbstractControl

org.dwcj.controls.AbstractDwcControl

org.dwcj.controls.listbox.AbstractDwclistControl

org.dwcj.controls.textcombobox.TextComboBox

All Implemented Interfaces:

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

public final class TextComboBox
extends AbstractDwclistControl
implements HasReadOnly, Focusable, HasMouseWheelCondition, TabTraversable, TextAlignable

ComboBoxEdit Control

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextComboBox.Expanse
static enum	TextComboBox.Theme

Nested classes/interfaces inherited from interface org.dwcj.interfaces.HasMouseWheelCondition

HasMouseWheelCondition.MouseWheelCondition

Nested classes/interfaces inherited from interface org.dwcj.interfaces.TextAlignable

TextAlignable.Alignment

Field Summary

Fields inherited from class org.dwcj.controls.listbox.AbstractDwclistControl

data2, values

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
TextComboBox()

Method Summary

Modifier and Type	Method	Description
TextComboBox	addClassName(String selector)	Adds a CSS class to the list of CSS classes for the control.
TextComboBox	addItem(Object key, String item)
TextComboBox	addItems(Map<Object,String> items)
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.
TextComboBox	closeList()
protected void	create(AbstractDwcjPanel p)	Create the object on a panel p.
TextComboBox	deselect()
Map<Object,String>	getAllItems()
String	getEditText()
String	getItemAt(Object key)
Integer	getItemCount()
HasMouseWheelCondition.MouseWheelCondition	getScrollWheelBehavior()	getScrollWheelBehavior returns a constant indicating under what situations the control will respond to the mouse scroll wheel.
Integer	getSelectedIndex()
AbstractMap.SimpleEntry<Object,String>	getSelectedItem()
TextAlignable.Alignment	getTextAlignment()	Returns a value indicating the text's horizontal alignment.
TextComboBox	insertItemAt(Object key, String item, Integer index)
TextComboBox	insertItemsAt(Map<Object,String> items, Integer index)
Boolean	isFocusable()	isFocusable returns a value indicating whether or not the user can focus the control.
Boolean	isReadOnly()	Returns a value indicating whether or not a control is set to read only or not.
Boolean	isTabTraversable()	Returns a boolean indicating whether or not the user can navigate to the control using the tab key.
TextComboBox	onChange(Consumer<TextComboBoxChangeEvent> callback)
TextComboBox	onClose(Consumer<TextComboBoxCloseEvent> callback)
TextComboBox	onEditModify(Consumer<TextComboBoxEditModifyEvent> callback)
TextComboBox	onOpen(Consumer<TextComboBoxOpenEvent> callback)
TextComboBox	onSelect(Consumer<TextComboBoxSelectEvent> callback)
TextComboBox	openList()
protected void	populate()
TextComboBox	removeAllItems()
TextComboBox	removeClassName(String selector)	Removes a CSS class from the list of CSS classes for the control.
TextComboBox	select(Integer indexStart, Integer indexEnd)
TextComboBox	selectIndex(Integer index)
TextComboBox	setAttribute(String attribute, String value)	set the value for an attribute in the control
TextComboBox	setEditText(String text)
TextComboBox	setEnabled(Boolean enabled)	Set whether the control is to be enabled
TextComboBox	setExpanse(TextComboBox.Expanse expanse)
TextComboBox	setFocusable(Boolean focusable)	setFocusable sets whether a control can be focused.
TextComboBox	setId(String elementId)	Assigns the ID of a control
TextComboBox	setItems(Map<Object,String> values)	set the list of items into the ComboBoxEdit
TextComboBox	setMaximumRowCount(Integer max)
TextComboBox	setReadOnly(Boolean readOnly)	Sets whether a user can edit the control.
TextComboBox	setScrollWheelBehavior(HasMouseWheelCondition.MouseWheelCondition condition)	setScrollWheelBehavior configures under what situations the control will respond to the mouse scroll wheel.
TextComboBox	setStyle(String property, String value)	Assigns specified value to the specified CSS property
TextComboBox	setTabTraversable(Boolean traversable)	Sets whether or not the user can navigate to the control using the tab key.
TextComboBox	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
TextComboBox	setTextAlignment(TextAlignable.Alignment textAlignment)	Sets the horizontal alignment of the text within the control.
TextComboBox	setTextAt(Integer idx, String text)
TextComboBox	setTheme(TextComboBox.Theme theme)
TextComboBox	setTooltipText(String text)	Set the tooltip text of the control
TextComboBox	setVisible(Boolean visible)	Set whether the control is visible or invisible

Methods inherited from class org.dwcj.controls.AbstractDwcControl

destroy, getAttribute, getComputedStyle, getText, 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

TextComboBox

public TextComboBox()

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

addItem

public TextComboBox addItem(Object key,
 String item)

insertItemAt

public TextComboBox insertItemAt(Object key,
 String item,
 Integer index)

addItems

public TextComboBox addItems(Map<Object,String> items)

insertItemsAt

public TextComboBox insertItemsAt(Map<Object,String> items,
 Integer index)

populate

protected void populate()

Specified by:

populate in class AbstractDwclistControl

closeList

public TextComboBox closeList()

deselect

public TextComboBox deselect()

getAllItems

public Map<Object,String> getAllItems()

getEditText

public String getEditText()

getItemAt

public String getItemAt(Object key)

getItemCount

public Integer getItemCount()

getSelectedIndex

public Integer getSelectedIndex()

getSelectedItem

public AbstractMap.SimpleEntry<Object,String> getSelectedItem()

openList

public TextComboBox openList()

removeAllItems

public TextComboBox removeAllItems()

select

public TextComboBox select(Integer indexStart,
 Integer indexEnd)

selectIndex

public TextComboBox selectIndex(Integer index)

setEditText

public TextComboBox setEditText(String text)

setItems

public TextComboBox setItems(Map<Object,String> values)

set the list of items into the ComboBoxEdit

Parameters:

values - A Map object containing the key-value pairs for the list

Returns:

the control itself

setMaximumRowCount

public TextComboBox setMaximumRowCount(Integer max)

setTextAt

public TextComboBox setTextAt(Integer idx,
 String text)

onSelect

public TextComboBox onSelect(Consumer<TextComboBoxSelectEvent> callback)

onChange

public TextComboBox onChange(Consumer<TextComboBoxChangeEvent> callback)

onOpen

public TextComboBox onOpen(Consumer<TextComboBoxOpenEvent> callback)

onClose

public TextComboBox onClose(Consumer<TextComboBoxCloseEvent> callback)

onEditModify

public TextComboBox onEditModify(Consumer<TextComboBoxEditModifyEvent> callback)

isReadOnly

public Boolean isReadOnly()

Description copied from interface: HasReadOnly

Returns a value indicating whether or not a control is set to read only or not.

Specified by:

isReadOnly in interface HasReadOnly

Returns:

Boolean indicating whether or not the user can edit the control.

setReadOnly

public TextComboBox setReadOnly(Boolean readOnly)

Description copied from interface: HasReadOnly

Sets whether a user can edit the control.

Specified by:

setReadOnly in interface HasReadOnly

Parameters:

readOnly - True to disable editing, false to enable editing.

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 TextComboBox 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

getScrollWheelBehavior

public HasMouseWheelCondition.MouseWheelCondition getScrollWheelBehavior()

Description copied from interface: HasMouseWheelCondition

getScrollWheelBehavior returns a constant indicating under what situations the control will respond to the mouse scroll wheel.

Specified by:

getScrollWheelBehavior in interface HasMouseWheelCondition

Returns:

Enum value of scroll behavior

setScrollWheelBehavior

public TextComboBox setScrollWheelBehavior(HasMouseWheelCondition.MouseWheelCondition condition)

Description copied from interface: HasMouseWheelCondition

setScrollWheelBehavior configures under what situations the control will respond to the mouse scroll wheel.

Specified by:

setScrollWheelBehavior in interface HasMouseWheelCondition

Parameters:

condition - Enum value for desired behavior

Returns:

The control 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 TextComboBox 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

getTextAlignment

public TextAlignable.Alignment getTextAlignment()

Description copied from interface: TextAlignable

Returns a value indicating the text's horizontal alignment.

Specified by:

getTextAlignment in interface TextAlignable

Returns:

setTextAlignment

public TextComboBox setTextAlignment(TextAlignable.Alignment textAlignment)

Description copied from interface: TextAlignable

Sets the horizontal alignment of the text within the control.

Specified by:

setTextAlignment in interface TextAlignable

Parameters:

textAlignment - Enum from list representing an internal BBj numeric constant

Returns:

The control itself

setText

public TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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 TextComboBox 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

setExpanse

public TextComboBox setExpanse(TextComboBox.Expanse expanse)

setTheme

public TextComboBox setTheme(TextComboBox.Theme theme)

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