de.ipcon.form

Class FTextInputComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.ipcon.swing.IPanel

de.ipcon.form.FPanel

de.ipcon.form.FInputPanel

de.ipcon.form.FTextInputComponent

All Implemented Interfaces:

AsyncRefreshExecutorI, FormElementI, FormInputPanelMandatoryI, InitialFocusCandidateI, de.ipcon.swing.FocusVetoHandlerI, L10nApplicatorI, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.Scrollable

Direct Known Subclasses:

FDateChooser, FSimpleDurationChooser, FText

public abstract class FTextInputComponent
extends FInputPanel
implements java.awt.event.FocusListener, javax.swing.event.DocumentListener, AsyncRefreshExecutorI, InitialFocusCandidateI

Abstract base class for de.ipcon.form components that handle textual input.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class de.ipcon.form.FInputPanel

myActions, myAttributes, myElements

Fields inherited from class de.ipcon.form.FPanel

XMLConfigureInfo

Fields inherited from class de.ipcon.swing.IPanel

inhibitFocusChange, SCROLLING_MODE_ANY, SCROLLING_MODE_HORIZONTAL_ONLY, SCROLLING_MODE_VERTICAL_ONLY, TEXTURE_CENTERED, TEXTURE_REPEAT

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface de.ipcon.form.InitialFocusCandidateI

$0

Fields inherited from interface de.ipcon.form.FormElementI

ALL_ACTIONS, AVAILABLE_ACTION_KIND, CONTEXTMENU_ACTION_KIND, LOCAL_ACTION_KIND, MENU_ACTION_KIND, NO_LOCAL_ACTION_KIND, NO_TOPMDI_ONLY_ACTION_KIND, NOT_AVAILABLE_ACTION_KIND, REFRESH_FROM_TRANSACTION, REFRESH_FROM_USER, SHORTCUT_ACTION_KIND, TOOLBAR_ACTION_KIND, TOPMDI_ONLY_ACTION_KIND

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FTextInputComponent(FormContextI ftx, electric.xml.Element confRoot)

Method Summary

Modifier and Type	Method and Description
void	changedUpdate(javax.swing.event.DocumentEvent e)
void	close()
void	disable()
void	enable()
void	focusGained(java.awt.event.FocusEvent fe) implementation for FocusListener: call of method selectAll()
void	focusLost(java.awt.event.FocusEvent fe) implementation for FocusListener: call of method selectNone()
java.lang.Integer	getAlign()
int	getBaseline(int width, int height) Returns the baseline of the component.
java.lang.Integer	getColumns()
java.lang.String	getExplicitNullProperty()
java.lang.String	getFallbackProperty()
java.lang.String	getFontSize()
java.lang.String	getFontStyle()
javax.swing.JComponent	getInitialFocus()
javax.swing.JComponent	getJComponent() Returns the "JComponent" associated with this form element.
java.lang.String	getProperty()
java.lang.String	getSelectedText()
int	getSelectionEnd()
int	getSelectionStart()
java.lang.String	getText()
abstract javax.swing.text.JTextComponent	getTextComponent()
boolean	hasFocus()
void	insertUpdate(javax.swing.event.DocumentEvent e)
boolean	isSelectAllWhenFocused()
void	performAdditionalFormElementDefinitionChecks()
void	postRefresh()
void	postRefresh(int from)
void	refresh(int from)
void	removeUpdate(javax.swing.event.DocumentEvent e)
boolean	requestFocusInWindow() Requests that this component gets the keyboard focus, specifically within its own window.
void	selectAll() Selects complete text of getTextComponent().
void	selectNone() Removes text selection of getTextComponent().
void	setAlign(java.lang.Integer align)
void	setColumns(java.lang.Integer columns)
boolean	setEditable()
boolean	setEditable(boolean editable) Added to toggle the textbox's enabled property.
void	setEnabled()
void	setEnabled(boolean enabled)
void	setExplicitNullProperty(java.lang.String explicitNullProperty)
void	setFallbackProperty(java.lang.String fallbackProperty)
void	setFontSize(java.lang.String fontSize)
void	setFontStyle(java.lang.String fontStyle)
void	setProperty(java.lang.String property)
void	setSelectAllWhenFocused(boolean selectAllWhenFocused)
void	setText(java.lang.String str)
void	setText(java.lang.String str, boolean doSync)
boolean	updateEditableStatus()
boolean	updateEditableStatus(boolean otherConstraint)

Methods inherited from class de.ipcon.form.FInputPanel

calculateMandatory, getAlsoMandatoryIf, getAttributeMap, getDefaultActionMap, getElementMap, handleAlsoMandatoryIfE

Methods inherited from class de.ipcon.form.FPanel

_refreshActions, action_editForm_available, action_editForm_enabled, action_editForm, action_refreshView_available, action_refreshView, action_reopenView_available, action_reopenView_enabled, action_reopenView, addFormElementListener, afterSave, afterSetValue, assureTransferHandler, beforeSave, beforeSetValue, calculationMightBeExpensive, callLog, cancelPendingRefreshRequests, checkEditable, checkVisible, evalScript, evalScript, evalScript, evalScript, evalScript, fhide, focusNextComponent, focusPreviousComponent, fshow, getActions, getActionsOfKind, getActionsOfKind, getBO, getConfRoot, getCtx, getDebugName, getDefinitionErrorHandler, getFormActions, getFtx, getInstrumentedSchema, getLastRefreshRequest, getMaximumSize, getMinimumSize, getMissingPropertiesPolicy, getPreferredSize, getRefreshRequestsPending, getSchema, handleActionE, handleDropAllowedIfE, handleEditableA, handleEditableIfE, handleImpliedA, handleMaximumSizeA, handleMaxSizeA, handleMinimumSizeA, handleMinSizeA, handleMissingPropertiesPolicyA, handleNameA, handleOnAfterSaveE, handleOnAfterSetValueE, handleOnBeforeSaveE, handleOnBeforeSetValueE, handleOnConstructionE, handleOnDropE, handleOnFocusGainedE, handleOnFocusLostE, handleOnMDIActivateE, handleOnMDICloseE, handleOnMDIDeactivateE, handleOnMDIOpenE, handleOnRefreshE, handleOnSyncE, handlePreferredSizeA, handlePrefSizeA, handleScriptE, handleVirtualPropertyE, handleVisibleIfE, hasPreferredSizeOverride, invokeAction, invokeAction, isClosed, isDebug, isDefinedEditable, isEditable, isExplicitEditable, isGUIBuilt, isImpliedElement, isInputPossible, isShown, mdiActivate, mdiClose, mdiDeactivate, mdiOpen, postConstructor, postInit, postRefresh, processFocusVeto, processFocusVeto, queueDelayedRefresh, queueDelayedRefresh, reallyHandleVirtualPropertyE, refresh, refreshActions, refreshActions, registerActionImpl, registerDefinitionErrorHandler, registerFormAction, removeFormElementListener, requestFocus, requestFocusInWindow, runAndDeclare, runAndDeclare, setConfRoot, setDebug, setFtx, setGUIBuilt, setMissingPropertiesPolicy, setShown, shouldShow, sync, syncImpl, waitForAsyncRefreshes, willCareForChildActions, willCareForChildRefresh

Methods inherited from class de.ipcon.swing.IPanel

getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollingMode, grabFocus, init, init, init, paintComponent, setScrollingMode, setTexture

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.form.AsyncRefreshExecutorI

calculateDisplayValue, lockDisplayValue, renderDisplayValue, restoreLockstateOfDisplayValue

Methods inherited from interface de.ipcon.form.FormElementI

addBeanA, addBeanA, addHandleA, addHandleA, addHandleE, addHandleE, applyL10n, getElementConsideringIgnored, getName, handleAttributes, handleElement, handleElements, handleElements, handleElements, handleElements, handleError, handleNewElement, handleNewElement, handleNewElement, isIgnored, showError, showError, toDebugName

Constructor Detail

FTextInputComponent

public FTextInputComponent(FormContextI ftx,
                           electric.xml.Element confRoot)

Method Detail

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getFontStyle

public java.lang.String getFontStyle()

setFontStyle

public void setFontStyle(java.lang.String fontStyle)

getFontSize

public java.lang.String getFontSize()

setFontSize

public void setFontSize(java.lang.String fontSize)

getColumns

public java.lang.Integer getColumns()

setColumns

public void setColumns(java.lang.Integer columns)

getAlign

public java.lang.Integer getAlign()

setAlign

public void setAlign(java.lang.Integer align)

isSelectAllWhenFocused

public boolean isSelectAllWhenFocused()

setSelectAllWhenFocused

public void setSelectAllWhenFocused(boolean selectAllWhenFocused)

getFallbackProperty

public java.lang.String getFallbackProperty()

setFallbackProperty

public void setFallbackProperty(java.lang.String fallbackProperty)

getExplicitNullProperty

public java.lang.String getExplicitNullProperty()

setExplicitNullProperty

public void setExplicitNullProperty(java.lang.String explicitNullProperty)

getTextComponent

public abstract javax.swing.text.JTextComponent getTextComponent()

performAdditionalFormElementDefinitionChecks

public void performAdditionalFormElementDefinitionChecks()

Specified by:

performAdditionalFormElementDefinitionChecks in interface FormElementI

close

public void close()

Specified by:

close in interface FormElementI

Overrides:

close in class FPanel

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

setText

public void setText(java.lang.String str)

setText

public void setText(java.lang.String str,
                    boolean doSync)

getText

public java.lang.String getText()

Returns:

text of getTextComponent() or null if getTextComponent() is null.

getSelectedText

public java.lang.String getSelectedText()

Returns:

the selected text of getTextComponent(). If getTextComponent() is null or the selection is null or the document is empty, returns null.

getSelectionStart

public int getSelectionStart()

Returns:

Returns the selected text of getTextComponent()'s start position. Return 0 if getTextComponent() is null or for an empty document, or the position of the cursor if no selection.

getSelectionEnd

public int getSelectionEnd()

Returns:

Returns the selected text of getTextComponent()'s end position. Return 0 if getTextComponent() is null or for an empty document, or the position of the cursor if no selection.

selectAll

public void selectAll()

Selects complete text of getTextComponent().

selectNone

public void selectNone()

Removes text selection of getTextComponent().

setEditable

public boolean setEditable()

setEditable

public boolean setEditable(boolean editable)

Added to toggle the textbox's enabled property. Used method name as editable as method with this name is called from FPopup.

Specified by:

setEditable in interface FormElementI

Overrides:

setEditable in class FPanel

updateEditableStatus

public boolean updateEditableStatus()

updateEditableStatus

public boolean updateEditableStatus(boolean otherConstraint)

setEnabled

public void setEnabled()

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class javax.swing.JComponent

disable

public void disable()

Overrides:

disable in class javax.swing.JComponent

enable

public void enable()

Overrides:

enable in class javax.swing.JComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Description copied from class: FPanel

Requests that this component gets the keyboard focus, specifically within its own window.

This method overrides JComponent.requestFocusInWindow() and delegates to the more specific FPanel.requestFocusInWindow(boolean) with "temporary" set to false.

Overrides:

requestFocusInWindow in class FPanel

Returns:

true if the focus request is likely to be granted, false otherwise.

getInitialFocus

public javax.swing.JComponent getInitialFocus()

Specified by:

getInitialFocus in interface InitialFocusCandidateI

getJComponent

public javax.swing.JComponent getJComponent()

Description copied from class: FInputPanel

Returns the "JComponent" associated with this form element.

Specified by:

getJComponent in class FInputPanel

Returns:

The "JComponent" of this form element.

hasFocus

public boolean hasFocus()

Overrides:

hasFocus in class java.awt.Component

focusGained

public void focusGained(java.awt.event.FocusEvent fe)

implementation for FocusListener: call of method selectAll()

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent fe)

implementation for FocusListener: call of method selectNone()

Specified by:

focusLost in interface java.awt.event.FocusListener

getBaseline

public int getBaseline(int width,
                       int height)

Description copied from class: FInputPanel

Returns the baseline of the component.

Overrides:

getBaseline in class FInputPanel

Parameters:

width - The width to get the baseline for.

height - The height to get the baseline for.

Returns:

The baseline of the component, or < 0 indicating there is no underlying JComponent or no reasonable baseline.

refresh

public void refresh(int from)

Specified by:

refresh in interface FormElementI

Overrides:

refresh in class FPanel

postRefresh

public void postRefresh()

Overrides:

postRefresh in class FPanel

postRefresh

public void postRefresh(int from)

Specified by:

postRefresh in interface FormElementI

Overrides:

postRefresh in class FPanel