fr.cnes.genius.lowLevel

Class GTextField

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTextField

All Implemented Interfaces:

GDisplay, GListener, ActionListener, FocusListener, KeyListener, MouseWheelListener, EventListener

Direct Known Subclasses:

GNumberFieldAbstract

public class GTextField
extends GComponent
implements GDisplay, GListener, ActionListener, FocusListener, KeyListener

Class representing a text entry field. By default the characters `~!@#$%&*()=\\|\"':;?/><, are forbidden and cannot be entered in the field. The class allows text entry in an object of type JTextField. When text has been changed and when the widget lose focus, an event of type GEvent is emitted. The escape key deletes the content of the field.

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GTextField.GDocumentFieldFilterAbstract Abstract class to handle the common functions of the DocumentFilter class.

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GTextField(String textValue) Default constructor.
GTextField(String widgetId, String textValue) Constructor with default document filter.
GTextField(String widgetId, String textValue, GDocumentFilterAbstract documentFilter) Constructor with default document filter.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	after(GEvent e) Called after the event is processed.
void	before(GEvent e) Called before the event is processed.
protected int	computeDefaultWidth(char character, int numChars) Compute the default with of the field based in the size of the font.
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
protected int	getCharWidth(char character) Get the width in pixels of the character using the field default font.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JTextField	getJTextField() Returns the Swing widget.
String	getText() Get the current text contained in the widget.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent ev)
void	setDocumentFilter(GDocumentFilterAbstract documentFilter) Set the document filter that will be used to validate the input.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setText(String textValue) Sets the test for the widget.

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GTextField

public GTextField(String textValue)

Default constructor.

Parameters:

textValue - initial value of the field.

GTextField

public GTextField(String widgetId,
                  String textValue)

Constructor with default document filter.

Parameters:

widgetId - identifier of the widget.

textValue - initial value of the field.

GTextField

public GTextField(String widgetId,
                  String textValue,
                  GDocumentFilterAbstract documentFilter)

Constructor with default document filter.

Parameters:

widgetId - identifier of the widget.

textValue - initial value of the field.

documentFilter - used to filter the valid inputs.

Method Detail

computeDefaultWidth

protected int computeDefaultWidth(char character,
                                  int numChars)

Compute the default with of the field based in the size of the font.

Parameters:

character - to compute the width.

numChars - number of characters to compute the width.

Returns:

the width of the field in pixesl.

getCharWidth

protected int getCharWidth(char character)

Get the width in pixels of the character using the field default font.

Parameters:

character - to compute the width.

Returns:

the width in pixels of the character using the field default font.

setEnabled

public void setEnabled(boolean flag)

Set the enable status of the component. When we enable the text field we also set it as editable.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

display

public void display()

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

keyTyped

public void keyTyped(KeyEvent ev)

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

getJTextField

public JTextField getJTextField()

Returns the Swing widget.

Returns:

The JTextField associated with the control.

setText

public void setText(String textValue)

Sets the test for the widget.

Parameters:

textValue - value of the text.

getText

public String getText()

Get the current text contained in the widget.

Returns:

the current text contained in the widget.

setDocumentFilter

public void setDocumentFilter(GDocumentFilterAbstract documentFilter)

Set the document filter that will be used to validate the input.

Parameters:

documentFilter - the document filter that will be used to validate the input.

before

public void before(GEvent e)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent e)
           throws GException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.