xdev.ui

Class XdevTextPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

xdev.ui.XComponent

xdev.ui.XdevComponent

xdev.ui.XdevTextPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ClientProperties, FormularComponent<XdevTextPane>, TextComponent, XdevTextComponent

Direct Known Subclasses:

XdevLayoutCell

@BeanSettings(useXdevCustomizer=true)
public class XdevTextPane
extends XdevComponent
implements XdevTextComponent, FormularComponent<XdevTextPane>

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

alpha, alphaColors, alphaCondition, alphaFilter, alphaTolerance, clip, filteredImage, imageBounds, remakeImages, style, useAlphaFilter

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

DATA_FIELD, FORMULAR_CONDITION_FILTER, FORMULAR_CONDITION_PRECISION, FORMULAR_FILTER_OPERATOR, FORMULAR_SKIP, FORMULAR_VERIFIER, TAG_DATA

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevTextPane() Constructor for creating a new instance of a XdevTextPane.

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.
void	drawText(Graphics2D g)
Insets	getBorderInsets(boolean withTextBorder)
Component	getCpn()
String	getDataField() Returns the name of the bound data field of this formular component.
XdevDocument	getDocument()
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.
int	getHorizontalAlign()
Dimension	getOriginalSize()
String	getText() Returns the text of this XdevTextPane.
int	getTextColumnCount() Deprecated.
int	getTextColumnGap() Deprecated.
Insets	getTextInsets()
boolean	getUnderline()
Validator[]	getValidators() Returns all validators of this component.
int	getVerticalAlign()
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	isOpaque()
boolean	isReadOnly() Determines whether this component is only used to display values.
boolean	isVertical()
boolean	paintAsImage()
protected boolean	paintComponent()
protected void	paintImage(Graphics2D g) TODO
void	removeValidator(Validator validator) Removes a validator from this component
void	reshape(int x, int y, int width, int height)
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	setHorizontalAlign(int align)
void	setPaintText()
void	setReadOnly(boolean readOnly) Sets if this form component is only used to display values.
void	setText(String str) Sets the new text of this XdevTextPane.
void	setText(String str, String contentType) Sets the new text of this XdevTextPane.
void	setTextAndPack(String str) This is an alias for setTextAndPack(String, String).
void	setTextAndPack(String str, String contentType)
void	setTextColumnCount(int textColumnCount) Deprecated.
void	setTextColumnGap(int textColumnGap) Deprecated.
void	setTextImagePath(String textImagePath)
void	setTextInsets(Insets i)
void	setUnderline(boolean underline)
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 xdev.ui.XdevComponent

checkAlphaUse, createG2D, drawTexture, forcePaint, getAlpha, getAlphaColors, getAlphaCondition, getAlphaTolerance, getBackgroundType, getBorderInsets, getGradientAlign, getGradientColor1, getGradientColor2, getSizeForFilter, getTexture, getTextureOption, getTexturePath, paintBackground, paintComponent, setAlpha, setAlphaColors, setAlphaCondition, setAlphaTolerance, setBackgroundType, setBorderTitle, setGradientAlign, setGradientColor1, setGradientColor2, setTexture, setTextureOption, setTexturePath, toString, update

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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

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, 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, 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.XdevTextComponent

getFont, getForeground, getPreferredSize, getSize, repaint, setPreferredSize, setSize

Methods inherited from interface xdev.ui.FormularComponent

getClientProperty, isEnabled, isVisible, putClientProperty

Constructor Detail

XdevTextPane

public XdevTextPane()

Constructor for creating a new instance of a XdevTextPane.

See Also:

XdevDocument

Method Detail

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class XdevComponent

paintComponent

protected boolean paintComponent()

Overrides:

paintComponent in class XdevComponent

getCpn

public Component getCpn()

Specified by:

getCpn in interface XdevTextComponent

reshape

public void reshape(int x,
                    int y,
                    int width,
                    int height)

Overrides:

reshape in class JComponent

getOriginalSize

public Dimension getOriginalSize()

Specified by:

getOriginalSize in interface XdevTextComponent

setText

public void setText(String str)

Sets the new text of this XdevTextPane.

This is an alias for setText(String, String) .

Specified by:

setText in interface TextComponent

Parameters:

str - the text to be displayed

See Also:

setText(String, String)

setText

public void setText(String str,
                    String contentType)

Sets the new text of this XdevTextPane.

Parameters:

str - the text to be displayed

contentType - the constants defined in XdevDocument: XdevDocument.CONTENT_TYPE_TEXT_PLAIN XdevDocument.CONTENT_TYPE_TEXT_RTF

setTextAndPack

public void setTextAndPack(String str)

This is an alias for setTextAndPack(String, String).

Parameters:

str -

setTextAndPack

public void setTextAndPack(String str,
                           String contentType)

getText

public String getText()

Returns the text of this XdevTextPane.

Specified by:

getText in interface TextComponent

Returns:

the text of this XdevTextPane.

getDocument

public XdevDocument getDocument()

Specified by:

getDocument in interface XdevTextComponent

setTextImagePath

public void setTextImagePath(String textImagePath)

getHorizontalAlign

public int getHorizontalAlign()

Specified by:

getHorizontalAlign in interface XdevTextComponent

setHorizontalAlign

public void setHorizontalAlign(int align)

getTextColumnCount

@Deprecated
public int getTextColumnCount()

Deprecated.

Specified by:

getTextColumnCount in interface XdevTextComponent

setTextColumnCount

@Deprecated
public void setTextColumnCount(int textColumnCount)

Deprecated.

Specified by:

setTextColumnCount in interface XdevTextComponent

getTextColumnGap

@Deprecated
public int getTextColumnGap()

Deprecated.

Specified by:

getTextColumnGap in interface XdevTextComponent

setTextColumnGap

@Deprecated
public void setTextColumnGap(int textColumnGap)

Deprecated.

Specified by:

setTextColumnGap in interface XdevTextComponent

getUnderline

public boolean getUnderline()

Specified by:

getUnderline in interface XdevTextComponent

setUnderline

public void setUnderline(boolean underline)

setPaintText

public void setPaintText()

Specified by:

setPaintText in interface XdevTextComponent

isVertical

public boolean isVertical()

Specified by:

isVertical in interface XdevTextComponent

getVerticalAlign

public int getVerticalAlign()

Specified by:

getVerticalAlign in interface XdevTextComponent

paintAsImage

public boolean paintAsImage()

Specified by:

paintAsImage in interface XdevTextComponent

getTextInsets

public Insets getTextInsets()

Specified by:

getTextInsets in interface XdevTextComponent

setTextInsets

public void setTextInsets(Insets i)

Specified by:

setTextInsets in interface XdevTextComponent

getBorderInsets

public Insets getBorderInsets(boolean withTextBorder)

Specified by:

getBorderInsets in interface XdevTextComponent

paintImage

protected void paintImage(Graphics2D g)

Description copied from class: XdevComponent

TODO

Specified by:

paintImage in class XdevComponent

drawText

public void drawText(Graphics2D g)

getFormularName

public String getFormularName()

Returns the name of the component in the formular context.

Specified by:

getFormularName in interface FormularComponent<XdevTextPane>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns:

true if this component is only used to display values.

Since:

3.2