xdev.ui

Class XdevLabel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

xdev.ui.XdevLabel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, LockTimeMonitor, FormularComponent<XdevLabel>, TextComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevLabel
extends JLabel
implements TextComponent, FormularComponent<XdevLabel>, LockTimeMonitor

The standard label in XDEV. Based on JLabel.

Since:

2.0

Author:

XDEV Software

See Also:

JLabel, Serialized Form

Nested Class Summary

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

JLabel.AccessibleJLabel

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

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

FormularComponent.ValueChangeListener

Field Summary

Fields inherited from class javax.swing.JLabel

labelFor

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 xdev.ui.FormularComponent

DATA_FIELD_SEPARATOR

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevLabel() Creates a XdevLabel instance with no image and with an empty string for the title.
XdevLabel(Icon image) Creates a XdevLabel instance with the specified image.
XdevLabel(Icon image, int horizontalAlignment) Creates a XdevLabel instance with the specified image and horizontal alignment.
XdevLabel(String text) Creates a XdevLabel instance with the specified text.
XdevLabel(String text, Icon icon) Creates a XdevLabel instance with the specified text and icon.
XdevLabel(String text, Icon icon, int horizontalAlignment) Creates a XdevLabel instance with the specified text, image, and horizontal alignment.
XdevLabel(String text, int horizontalAlignment) Creates a XdevLabel instance with the specified text and horizontal alignment.

Method Summary

Modifier and Type	Method and Description
void	addValidator(Validator validator) Adds a validator to this component
void	addValueChangeListener(FormularComponent.ValueChangeListener l) Registers a FormularComponent.ValueChangeListener.
String	getDataField() Returns the name of the bound data field of this formular component.
Operator	getFilterOperator() Returns the operator used in Formular.createCondition(String)
String	getFormularName() Returns the name of the component in the formular context.
Object	getFormularValue() Returns the value of the component.
Validator[]	getValidators() Returns all validators of this component.
boolean	hasStateChanged() Checks if the component's state since the last call of FormularComponent.saveState() has changed.
boolean	isMultiSelect() Returns whether the component supports multi selection or not.
boolean	isReadOnly() Determines whether this component is only used to display values.
void	removeValidator(Validator validator) Removes a validator from this component
void	restoreState() Restores the internally saved state of the component.
void	saveState() Saves the state of the component internally.
void	setDataField(String dataField) Sets the name of the bound data field of this formular component.
void	setFilterOperator(Operator filterOperator) Sets the filter operator used in Formular.createCondition(String)
void	setFormularValue(VirtualTable vt, int col, Object value) Deprecated.
void	setFormularValue(VirtualTable vt, Map<String,Object> record) Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().
void	setReadOnly(boolean readOnly) Sets if this form component is only used to display values.
void	setText(String text) Sets the text of this TextComponent to the specified text.
String	toString()
void	updateContext(Countdown countdown, long remainingTime) Updates the monitors display context.
void	validateState() Calls Validator.validate(Object) of all registered Validators.
void	validateState(Validation validation) Calls Validator.validate(Object) of all registered Validators.
boolean	verify() Returns whether the component's value adheres all set constraints.

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setUI, setVerticalAlignment, setVerticalTextPosition, 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, processKeyBinding, processKeyEvent, 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, setEnabled, setFocusTraversalKeys, setFont, 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, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.ui.TextComponent

getText

Methods inherited from interface xdev.ui.FormularComponent

getClientProperty, isEnabled, isVisible, putClientProperty

Constructor Detail

XdevLabel

public XdevLabel()

Creates a XdevLabel instance with no image and with an empty string for the title. The XdevLabel is centered vertically in its display area. The label's contents, once set, will be displayed on the leading edge of the label's display area.

XdevLabel

public XdevLabel(String text)

Creates a XdevLabel instance with the specified text. The XdevLabel is aligned against the leading edge of its display area, and centered vertically.

Parameters:

text - The text to be displayed by the label.

XdevLabel

public XdevLabel(String text,
                 int horizontalAlignment)

Creates a XdevLabel instance with the specified text and horizontal alignment. The XdevLabel is centered vertically in its display area.

Parameters:

text - The text to be displayed by the label.

horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.

XdevLabel

public XdevLabel(String text,
                 Icon icon)

Creates a XdevLabel instance with the specified text and icon. The XdevLabel is aligned against the leading edge of its display area, and centered vertically.

Parameters:

text - The text to be displayed by the label.

icon - The Icon to be displayed by the label.

XdevLabel

public XdevLabel(Icon image)

Creates a XdevLabel instance with the specified image. The XdevLabel is centered vertically and horizontally in its display area.

Parameters:

image - The image to be displayed by the label.

XdevLabel

public XdevLabel(Icon image,
                 int horizontalAlignment)

Creates a XdevLabel instance with the specified image and horizontal alignment. The XdevLabel is centered vertically in its display area.

Parameters:

image - The Icon to be displayed by the label.

horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.

XdevLabel

public XdevLabel(String text,
                 Icon icon,
                 int horizontalAlignment)

Creates a XdevLabel instance with the specified text, image, and horizontal alignment. The XdevLabel is centered vertically in its display area. The text is on the trailing edge of the image.

Parameters:

text - The text to be displayed by the label.

icon - The Icon to be displayed by the label.

horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.

Method Detail

setText

public void setText(String text)

Sets the text of this TextComponent to the specified text. If the text is null or empty, has the effect of simply deleting the old text.

Specified by:

setText in interface TextComponent

Overrides:

setText in class JLabel

Parameters:

text - the new text to be set

getFormularName

public String getFormularName()

Returns the name of the component in the formular context.

Specified by:

getFormularName in interface FormularComponent<XdevLabel>

Returns:

the name of the component in the formular context.

Since:

3.1

setDataField

public void setDataField(String dataField)

Sets the name of the bound data field of this formular component.

Specified by:

setDataField in interface FormularComponent<XdevLabel>

Parameters:

dataField - the new bound data field

Since:

3.1

getDataField

public String getDataField()

Returns the name of the bound data field of this formular component.

Specified by:

getDataField in interface FormularComponent<XdevLabel>

Returns:

the name of the bound data field

Since:

3.1

setFormularValue

@Deprecated
public final void setFormularValue(VirtualTable vt,
                                               int col,
                                               Object value)

Deprecated.

Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.

Specified by:

setFormularValue in interface FormularComponent<XdevLabel>

Parameters:

vt - VirtualTable to use the format from

col - of the column to use the format from

value - value to set

setFormularValue

public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)

Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().

Specified by:

setFormularValue in interface FormularComponent<XdevLabel>

Parameters:

vt - the underlying virtual table

record - the data <column,value>

Since:

3.2

getFormularValue

public Object getFormularValue()

Returns the value of the component.

Specified by:

getFormularValue in interface FormularComponent<XdevLabel>

Returns:

the value of the component.

Since:

3.1

saveState

public void saveState()

Saves the state of the component internally.

A saved state can be restored using FormularComponent.restoreState().

Specified by:

saveState in interface FormularComponent<XdevLabel>

Since:

3.1

restoreState

public void restoreState()

Restores the internally saved state of the component.

The state of the component can be saved using FormularComponent.saveState().

Specified by:

restoreState in interface FormularComponent<XdevLabel>

Since:

3.1

hasStateChanged

public boolean hasStateChanged()

Checks if the component's state since the last call of FormularComponent.saveState() has changed.

Specified by:

hasStateChanged in interface FormularComponent<XdevLabel>

Returns:

true if the component's state has changed, false otherwise

Since:

3.1

addValueChangeListener

public void addValueChangeListener(FormularComponent.ValueChangeListener l)

Registers a FormularComponent.ValueChangeListener.

Specified by:

addValueChangeListener in interface FormularComponent<XdevLabel>

Parameters:

l - the listener to register

Since:

3.1

isMultiSelect

public boolean isMultiSelect()

Returns whether the component supports multi selection or not.

A component that supports multi selection can have more than one selected item / value.

Specified by:

isMultiSelect in interface FormularComponent<XdevLabel>

Returns:

true if the component supports multi selection, false otherwise.

Since:

3.1

verify

public boolean verify()

Returns whether the component's value adheres all set constraints.

This is a alternative method for FormularComponent.validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.

Specified by:

verify in interface FormularComponent<XdevLabel>

Returns:

true if the value of the component adheres all set constraints; otherwise false.

Since:

3.1

addValidator

public void addValidator(Validator validator)

Adds a validator to this component

Specified by:

addValidator in interface FormularComponent<XdevLabel>

Parameters:

validator - the validator to add

Since:

3.1

See Also:

FormularComponent.validateState()

removeValidator

public void removeValidator(Validator validator)

Removes a validator from this component

Specified by:

removeValidator in interface FormularComponent<XdevLabel>

Parameters:

validator - the validator to remove

Since:

3.1

See Also:

FormularComponent.validateState()

getValidators

public Validator[] getValidators()

Returns all validators of this component.

If no validator is present an empty array is returned.

Specified by:

getValidators in interface FormularComponent<XdevLabel>

Returns:

all validators of this component

Since:

3.1

validateState

public void validateState()
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Specified by:

validateState in interface FormularComponent<XdevLabel>

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

validateState

public void validateState(Validation validation)
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.

Specified by:

validateState in interface FormularComponent<XdevLabel>

Parameters:

validation - the validation process object

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

setFilterOperator

public void setFilterOperator(Operator filterOperator)

Sets the filter operator used in Formular.createCondition(String)

Specified by:

setFilterOperator in interface FormularComponent<XdevLabel>

Parameters:

filterOperator - the new filter operator

Since:

3.1

getFilterOperator

public Operator getFilterOperator()

Returns the operator used in Formular.createCondition(String)

Specified by:

getFilterOperator in interface FormularComponent<XdevLabel>

Returns:

the component's filter operator

Since:

3.1

setReadOnly

public void setReadOnly(boolean readOnly)

Sets if this form component is only used to display values.

Specified by:

setReadOnly in interface FormularComponent<XdevLabel>

Parameters:

readOnly - true to only display values

Since:

3.2

isReadOnly

public boolean isReadOnly()

Determines whether this component is only used to display values.

Specified by:

isReadOnly in interface FormularComponent<XdevLabel>

Returns:

true if this component is only used to display values.

Since:

3.2

toString

public String toString()

Overrides:

toString in class Component

updateContext

public void updateContext(Countdown countdown,
                          long remainingTime)

Updates the monitors display context.

Specified by:

updateContext in interface LockTimeMonitor

Parameters:

countdown - to get the lock countown duration.

remainingTime - the remaining lock time.