Package org.dwcj.controls.numericbox

Class NumericBox

java.lang.Object
org.dwcj.controls.AbstractControl
org.dwcj.controls.AbstractDwcControl
org.dwcj.controls.numericbox.NumericBox
All Implemented Interfaces:
Control, Enableable, Focusable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasReadOnly, HasStyle, HasTooltip, HasVisibility, TabTraversable, TextAlignable, TextHighlightable
Direct Known Subclasses:
NumericBoxSpinner
public class NumericBox extends AbstractDwcControl implements HasReadOnly, Focusable, TabTraversable, TextAlignable, TextHighlightable

  • Field Details

  • Constructor Details

    • NumericBox

      public NumericBox(String text)

    • NumericBox

      public NumericBox()

  • 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

    • onEditModify

      public NumericBox onEditModify(Consumer<NumericBoxEditModifyEvent> callback)

    • getCommaCharacter

      public String getCommaCharacter()
      Returns the comma character used in the NumericBox control.
      Returns:
      Returns the character that is used as the comma in the control.

    • getDotCharacter

      public String getDotCharacter()
      Returns the character to be used indicating the decimal point in the NumericBox control.
      Returns:
      Returns the character to be used indicating the decimal point.

    • getEditString

      public String getEditString()
      Returns the EDIT string which is used to map input characters to edit functions for the NumericBox control.
      Returns:
      Returns the EDIT string which is used to map input characters to edit functions for the control.

    • getError

      public Integer getError()
      Returns the number of the last error generated in the NumericBox control.
      Returns:
      Returns the number of the last error generated in the control.

    • isHighlight

      public Boolean isHighlight()
      Returns whether the text in the NumericBox control is highlighted when focus is gained from tabbing into the control.
      Returns:
      Returns whether the text in the control is highlighted (false = Not highlighted, true = highlighted).

    • isInsertMode

      public Boolean isInsertMode()
      Returns whether the NumericBox control is in insert mode.
      Returns:
      Returns whether the control is in the insert mode (false = Not in insert mode, true = In insert mode).

    • getLength

      public int getLength()
      Returns the length of the text in the NumericBox control.
      Returns:
      Returns the length of the text in the control.

    • getMargin

      public Integer getMargin()
      This method returns the left margin of the NumericBox control.
      Returns:
      Returns the left margin of the control.

    • getMask

      public String getMask()
      Returns the mask of the NumericBox control.
      Returns:
      Returns the mask of the control, which provides character-type verification.

    • isNegatable

      public Boolean isNegatable()
      Returns whether the NumericBox control will accept negative values.
      Returns:
      Returns whether this control will accept negative values.

    • isPassEnter

      public Boolean isPassEnter()
      Returns whether the NumericBox control passes the ENTER key to the top-level window.
      Returns:
      Returns whether the ENTER key is passed to the top-level window (false = Not passed, true = Passed).

    • isPassTab

      public Boolean isPassTab()
      Returns whether the NumericBox control passes the TAB key notification to the top-level window.
      Returns:
      Returns whether the TAB key notification is passed to the top-level window (false = Not passed, true = Passed) .

    • getRestore

      public String getRestore()
      Returns the restore string of the NumericBox control.
      Returns:
      Returns the restore string of the BBjInputN control - the restore string is the text that appears when a user hits the restore key (usually ESC) or by calling the NumericBox::restore method.

    • isUseEditCommas

      public Boolean isUseEditCommas()
      Returns whether comma characters are displayed while in edit mode in the NumericBox control.
      Returns:
      Returns whether comma characters are displayed while in edit mode (0 = Do not display commas, 1 = Display commas). By default, commas are not displayed.

    • getValue

      public BigDecimal getValue()
      Returns the value of the contents of the NumericBox control.
      Returns:
      Returns the value of the contents of the control.

    • restore

      public void restore()
      Sets the text in the NumericBox control to the restore string. The restore string is set in the creation of the BBjInputN control or by calling the NumericBox::setRestoreString method.

    • selectAll

      public NumericBox selectAll()
      This method selects all of the NumericBox control's current contents as if the user highlighted it with the mouse or keyboard.
      Returns:
      Returns this

    • setCommaCharacter

      public NumericBox setCommaCharacter(String comma)
      Sets the comma character to be used in the NumericBox control. This will replace the character used to indicate a comma mask character.
      Parameters:
      comma - - Specifies the character to use for a comma.
      Returns:
      Returns this

    • setDotCharacter

      public NumericBox setDotCharacter(String dot)
      Sets the character used to indicate the decimal point. This will replace the character used to indicate the decimal point.
      Parameters:
      dot - - Specifies the character to use, which indicates the decimal point.
      Returns:
      Returns this

    • setEditString

      public NumericBox setEditString(String edit)
      Sets the EDIT string, which is used to map input characters to edit functions for theNumericBox control.
      Parameters:
      edit - - Specifies the EDIT string.
      Returns:
      Returns this

    • setHighlight

      public NumericBox setHighlight(Boolean highlight)
      Sets whether to highlight the text in the control when focus is gained from tabbing into the control.
      Parameters:
      highlight - - Specifies whether the text is to be highlighted (false = No highlight, true = Highlight)
      Returns:
      Returns this

    • setInsertMode

      public NumericBox setInsertMode(Boolean insert)
      Sets whether the NumericBox control is in insert mode.
      Parameters:
      insert - - Sets whether the control is in insert mode (false = Not in insert mode, true = In insert mode)
      Returns:
      Returns this

    • setLength

      public NumericBox setLength(Integer len)
      Sets the length of the text in the NumericBox control. If the setLength method is called, then the previous mask is not used. The mask for the characters will be the default mask character "X".
      Parameters:
      len - - Specifies the length of the text in the control.
      Returns:
      Returns this

    • setMargin

      public NumericBox setMargin(Integer marginWidth)
      Sets the left margin of the NumericBox control.
      Parameters:
      marginWidth - - Width of the left margin.
      Returns:
      Returns this

    • setMask

      public NumericBox setMask(String mask)
      Sets the mask for the NumericBox control.
      Parameters:
      mask - - Specifies the mask that provides character-type verification.
      Returns:
      Returns this

    • setNegatable

      public NumericBox setNegatable(boolean negatable)
      Sets whether the NumericBox control accepts negative values. Negative values are initially accepted.
      Parameters:
      negatable - - Specifies whether the BBjInputN will accept negative values (false = Negative values are not accepted, true = Negative values are accepted).
      Returns:
      Returns this

    • setPassEnter

      public NumericBox setPassEnter(Boolean pass)
      Sets whether the NumericBox control is to pass the ENTER key notification to the top-level window. By default, the ENTER key is not passed.
      Parameters:
      pass - - Specifies whether to pass the ENTER key to the top-level window (false = Not passed, true = Passed).
      Returns:
      Returns this

    • setPassTab

      public NumericBox setPassTab(Boolean pass)
      Sets whether the NumericBox control is to pass the TAB key notification to the top-level window.
      Parameters:
      pass - - Specifies whether to pass the TAB key notification to the top-level window (false = Not passed, true = Passed).
      Returns:
      Returns this

    • setRestore

      public NumericBox setRestore(float restore)
      Sets the restore value of the NumericBox control. The restore value is the number that appears when the user hits the restore key (usually ESC) or by calling the NumericBox::restore method.
      Parameters:
      restore - - Specifies the restore value.
      Returns:
      Returns this

    • setUseEditCommas

      public NumericBox setUseEditCommas(boolean useCommas)
      Sets whether to display the comma characters in the mask while in edit mode in the NumericBox control.
      Parameters:
      useCommas - - Specifies whether to display the comma characters in the mask while in edit mode (false = No display, true = Display)
      Returns:
      Returns this

    • setValue

      public NumericBox setValue(BigDecimal value)
      Sets the value of the NumericBox control. Note that a mask within a control does NOT round, but a mask within the STR() DOES round. For example, when placing a value such as 12.34567 into an inputN control that is masked with ###0.00, you'll get 12.34. However, if in console mode you print str(12.34567:"###0.00"), you'll get 12.35.
      Parameters:
      value - - Specifies the value to be set in the control.
      Returns:
      Returns this

    • setValue

      public NumericBox setValue(float value)

    • setValue

      public NumericBox setValue(int value)

    • isReadOnly

      public Boolean isReadOnly()
      Returns whether the text in the NumericBox control can be edited.
      Specified by:
      isReadOnly in interface HasReadOnly
      Returns:
      Returns whether the text in the control can be edited (false = Not Editable, true = Editable). By default, the text is editable.

    • setReadOnly

      public NumericBox setReadOnly(Boolean editable)
      Sets whether the text in the NumericBox control can be edited. By default, the control is editable.
      Specified by:
      setReadOnly in interface HasReadOnly
      Parameters:
      editable - - Sets the editability of the control (false = Not Editable, true = Editable)
      Returns:
      Returns this

    • 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 NumericBox 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 NumericBox setTabTraversable(Boolean traverse)
      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:
      traverse - Boolean dictating tab traversal. True if control can be navigated to with Tab, False if not.
      Returns:
      The control itself

    • getHighlightOnFocus

      public TextHighlightable.Highlight getHighlightOnFocus()
      Description copied from interface: TextHighlightable
      This method returns an enum representing the current behavior of highlighting in a text control when the control receives focus.
      Specified by:
      getHighlightOnFocus in interface TextHighlightable
      Returns:
      Enum representing BBj constant for highlight on focus

    • setHighlightOnFocus

      public NumericBox setHighlightOnFocus(TextHighlightable.Highlight highlight)
      Description copied from interface: TextHighlightable
      This method sets the behavior of controls implementing the TextControl interface when receiving focus via the keyboard, mouse, or BBjControl::focus() method FOCUS mnemonic.
      Specified by:
      setHighlightOnFocus in interface TextHighlightable
      Parameters:
      highlight - Enum representing a BBj constant that dictates highlight behavior for control
      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 NumericBox setTextAlignment(TextAlignable.Alignment alignment)
      Description copied from interface: TextAlignable
      Sets the horizontal alignment of the text within the control.
      Specified by:
      setTextAlignment in interface TextAlignable
      Parameters:
      alignment - Enum from list representing an internal BBj numeric constant
      Returns:
      The control itself

    • setText

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

    • setTheme

      public NumericBox setTheme(NumericBox.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