Package org.basex.gui.layout

Class BaseXCombo

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox<Object>

org.basex.gui.layout.BaseXCombo

All Implemented Interfaces:

ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, ListDataListener

Direct Known Subclasses:

GUIInput

public class BaseXCombo
extends JComboBox<Object>

Project specific ComboBox implementation.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComboBox

JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
BaseXCombo(BaseXWindow win, boolean editable, String... values)	Constructor.
BaseXCombo(BaseXWindow win, String... values)	Constructor.
BaseXCombo(BaseXWindow win, BooleanOption option, Options options)	Constructor.
BaseXCombo(BaseXWindow win, EnumOption<?> option, Options options)	Constructor.
BaseXCombo(BaseXWindow win, NumberOption option, Options options, String... values)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener l)
void	addKeyListener(KeyListener l)
void	assign()	Assigns the current checkbox value to the option specified in the constructor.
KeyListener[]	getKeyListeners()
String	getSelectedItem()
String	getText()	Returns the current text.
void	highlight(boolean hits)	Highlights the text field.
BaseXCombo	hint(String label)	Adds a hint to the text field.
final BaseXCombo	history(StringsOption opt, Options opts)	Attaches a history and enables a listener for cursor down/up keys.
void	removeFocusListener(FocusListener l)
void	removeKeyListener(KeyListener l)
void	setFont(Font font)
void	setItems(String... items)	Sets the specified items.
void	setSelectedItem(Object object)
void	setText(String text)	Sets the current text.
BaseXTextField	textField()	Returns the editor text field, or null if the combobox is not editable.
void	updateHistory()	Stores the current history and refreshes the selectable items.

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setUI, showPopup, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

BaseXCombo

public BaseXCombo(BaseXWindow win,
 NumberOption option,
 Options options,
 String... values)

Constructor.

Parameters:

win - parent window

option - numeric value

options - options

values - combobox values

BaseXCombo

public BaseXCombo(BaseXWindow win,
 BooleanOption option,
 Options options)

Constructor.

Parameters:

win - parent window

option - boolean value

options - options

BaseXCombo

public BaseXCombo(BaseXWindow win,
 EnumOption<?> option,
 Options options)

Constructor.

Parameters:

win - parent window

option - enum value

options - options

BaseXCombo

public BaseXCombo(BaseXWindow win,
 String... values)

Constructor.

Parameters:

win - parent window

values - combobox values

BaseXCombo

public BaseXCombo(BaseXWindow win,
 boolean editable,
 String... values)

Constructor.

Parameters:

win - parent window

editable - editable flag

values - combobox values

Method Details

history

public final BaseXCombo history(StringsOption opt,
 Options opts)

Attaches a history and enables a listener for cursor down/up keys.

Parameters:

opt - strings option

opts - options

Returns:

self reference

hint

public BaseXCombo hint(String label)

Adds a hint to the text field.

Parameters:

label - text of the hint

Returns:

self reference

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent

setItems

public void setItems(String... items)

Sets the specified items.

Parameters:

items - items

updateHistory

public void updateHistory()

Stores the current history and refreshes the selectable items.

getText

public String getText()

Returns the current text.

Returns:

text

setText

public void setText(String text)

Sets the current text.

Parameters:

text - text to be assigned

getSelectedItem

public String getSelectedItem()

Overrides:

getSelectedItem in class JComboBox<Object>

textField

public BaseXTextField textField()

Returns the editor text field, or null if the combobox is not editable.

Returns:

text field

setSelectedItem

public void setSelectedItem(Object object)

Overrides:

setSelectedItem in class JComboBox<Object>

highlight

public void highlight(boolean hits)

Highlights the text field.

Parameters:

hits - hits

getKeyListeners

public KeyListener[] getKeyListeners()

Overrides:

getKeyListeners in class Component

addKeyListener

public void addKeyListener(KeyListener l)

Overrides:

addKeyListener in class Component

removeKeyListener

public void removeKeyListener(KeyListener l)

Overrides:

removeKeyListener in class Component

addFocusListener

public void addFocusListener(FocusListener l)

Overrides:

addFocusListener in class Component

removeFocusListener

public void removeFocusListener(FocusListener l)

Overrides:

removeFocusListener in class Component

assign

public void assign()

Assigns the current checkbox value to the option specified in the constructor.