Package org.dwcj.controls.navigator

Class Navigator

java.lang.Object

org.dwcj.controls.AbstractControl

org.dwcj.controls.AbstractDwcControl

org.dwcj.controls.navigator.Navigator

All Implemented Interfaces:

Control, Enableable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasReadOnly, HasStyle, HasTooltip, HasVisibility

public final class Navigator
extends AbstractDwcControl
implements HasReadOnly

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Navigator	addClassName(String selector)	Adds a CSS class to the list of CSS classes for the control.
protected void	create(AbstractDwcjPanel p)	Create the object on a panel p.
com.basis.resource.RecordSet	getTargetRecordSet()
Boolean	isReadOnly()	Returns a value indicating whether or not a control is set to read only or not.
Navigator	onFirst(Consumer<NavigatorFirstEvent> callback)
Navigator	onLast(Consumer<NavigatorLastEvent> callback)
Navigator	onNext(Consumer<NavigatorNextEvent> callback)
Navigator	onPrevious(Consumer<NavigatorPreviousEvent> callback)
Navigator	removeClassName(String selector)	Removes a CSS class from the list of CSS classes for the control.
Navigator	setAttribute(String attribute, String value)	set the value for an attribute in the control
Navigator	setEnabled(Boolean enabled)	Set whether the control is to be enabled
Navigator	setExpanse(Navigator.Expanse expanse)
Navigator	setId(String elementId)	Assigns the ID of a control
Navigator	setReadOnly(Boolean editable)	Sets whether a user can edit the control.
Navigator	setStyle(String property, String value)	Assigns specified value to the specified CSS property
Navigator	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
Navigator	setTheme(Navigator.Theme theme)
Navigator	setTooltipText(String text)	Set the tooltip text of the control
Navigator	setVisible(Boolean visible)	Set whether the control is visible or invisible

Methods inherited from class org.dwcj.controls.AbstractDwcControl

catchUp, 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

Navigator

public Navigator()

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

getTargetRecordSet

public com.basis.resource.RecordSet getTargetRecordSet()

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 Navigator setReadOnly(Boolean editable)

Description copied from interface: HasReadOnly

Sets whether a user can edit the control.

Specified by:

setReadOnly in interface HasReadOnly

Parameters:

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

Returns:

The control itself.

onFirst

public Navigator onFirst(Consumer<NavigatorFirstEvent> callback)

onLast

public Navigator onLast(Consumer<NavigatorLastEvent> callback)

onNext

public Navigator onNext(Consumer<NavigatorNextEvent> callback)

onPrevious

public Navigator onPrevious(Consumer<NavigatorPreviousEvent> callback)

setText

public Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator 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 Navigator setExpanse(Navigator.Expanse expanse)

setTheme

public Navigator setTheme(Navigator.Theme theme)