fr.cnes.genius.highLevel

Class GEntryFileName

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.highLevel.GEntryFileName

All Implemented Interfaces:

GClear, GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GEntryFileName
extends GContainer
implements GDisplay, GReadWrite, GListener, GClear

Class to define a widget for searching file names giving its relative or absolute names.

Author:

goesterjf

Nested Class Summary

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
GEntryFileName() Constructor by default.
GEntryFileName(String widgetId, boolean isRelative, String label, String iniVal, String varName, int width, String titleFileChooser, String description, String suffix) Constructor
GEntryFileName(String label, String value) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	before(GEvent e) Called before the event is processed.
void	clear() Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.
static String	correctFileName(String iniName, String iniLocalDir) Method to extract the relative name with "/" rather than "\" and to test also if the file exists !
static String	correctFileName(String iniName, String iniLocalDir, boolean testExist) Method to extract the relative name with "/" rather than "\" and to test also if the file exists !
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	generic() The prototype of the generic function that shall exist in all the descendants.
File	getFile() Method to get the selected file.
String	getFileName() Method to get the selected file name.
GIntervalAbstract.GStatus	getStatus() Get the status of the widget.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
static File	selectFileWithChooser(int type, String iniPath, boolean blockDir, String title, String tooltipTex, String description, String suffix) Opens a JFileChooser to select a file.
void	setForcedStatus(GIntervalAbstract.GStatus status) Set the status of the widget.
void	setLabel(String label) Method to change the label.
void	updateStatus() Update the status of the field applying the defined file name.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, 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

GEntryFileName

public GEntryFileName(String widgetId,
                      boolean isRelative,
                      String label,
                      String iniVal,
                      String varName,
                      int width,
                      String titleFileChooser,
                      String description,
                      String suffix)

Constructor

Parameters:

widgetId - Identifier of the widget

isRelative - Relative name if true (absolute else)

label - label

iniVal - initial value

varName - variable name in the XML file

width - entry area width

titleFileChooser - title of the file chooser panel

description - description of the type of files to search

suffix - suffix of the files

GEntryFileName

public GEntryFileName()

Constructor by default.

GEntryFileName

public GEntryFileName(String label,
                      String value)

Constructor.

Parameters:

widgetId - Identifier of the widget.

label - Label of the entry.

value - Value of the entry.

Method Detail

display

public void display()
             throws GException

Description copied from interface: GDisplay

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

Throws:

GException - in case of problem while reading the value from file.

generic

public void generic()
             throws GException

Description copied from class: GContainer

The prototype of the generic function that shall exist in all the descendants.

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

read

public void read()
          throws GException

Description copied from interface: GReadWrite

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

GException - in case of problem while reading the value from file.

write

public void write()
           throws GException

Description copied from interface: GReadWrite

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

before

public void before(GEvent e)
            throws GException

Description copied from interface: GListener

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

Description copied from interface: GListener

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.

updateStatus

public void updateStatus()

Update the status of the field applying the defined file name.

setForcedStatus

public void setForcedStatus(GIntervalAbstract.GStatus status)

Set the status of the widget.

Overrides:

setForcedStatus in class GComponent

Parameters:

status - the new status of the widget.

setLabel

public void setLabel(String label)

Method to change the label.

Parameters:

label - the new label

getStatus

public GIntervalAbstract.GStatus getStatus()

Get the status of the widget.

Overrides:

getStatus in class GComponent

Returns:

the status of the widget.

clear

public void clear()
           throws GException

Description copied from interface: GClear

Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.

Specified by:

clear in interface GClear

Throws:

GException - in case of problem while clearing the values.

selectFileWithChooser

public static File selectFileWithChooser(int type,
                                         String iniPath,
                                         boolean blockDir,
                                         String title,
                                         String tooltipTex,
                                         String description,
                                         String suffix)

Opens a JFileChooser to select a file.

Parameters:

type - JFileChooser type

iniPath - initial directory path

blockDir - block inside the directory path if true

title - sub window title

tooltipTex - tooltip text

description - description

suffix - file suffix (may be null)

Returns:

File object selected (may be null)

correctFileName

public static String correctFileName(String iniName,
                                     String iniLocalDir)

Method to extract the relative name with "/" rather than "\" and to test also if the file exists !

Parameters:

iniName - initial file full name

iniLocalDir - local directory path

Returns:

relative name with "/" ... or "" if the file does not exist

correctFileName

public static String correctFileName(String iniName,
                                     String iniLocalDir,
                                     boolean testExist)

Method to extract the relative name with "/" rather than "\" and to test also if the file exists !

Parameters:

iniName - initial file full name

iniLocalDir - local directory path

testExist - test if the file exists if true

Returns:

relative name with "/" ... or "" if the file does not exist

getFileName

public String getFileName()

Method to get the selected file name.

Returns:

the file name

getFile

public File getFile()

Method to get the selected file.

Returns:

the file

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.