public class GListWithLabel extends GContainer implements GDisplay, GReadWrite, GListener, GClear
GList
with a GLabelWithIndicator
and adds the
GReadWrite
interface to save/load the selected value from the
configuration file. The class allows a sole choice with the same function as
the function of GChoice
but the interface is implemented via a list
GList
instead of a group of GRadioButtons.GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation
NAME_ATTRIBUTE
Constructor and Description |
---|
GListWithLabel()
Constructor by default.
|
GListWithLabel(String label,
List<String> data)
Constructor.
|
GListWithLabel(String widgetId,
String label)
Constructor.
|
GListWithLabel(String widgetId,
String label,
List<String> dataList)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
after(GEvent e)
Called after the event is processed.
|
void |
attachCopyPasteMenu(String label,
GComponent.CopyPasteOperation... operationList)
Attach the copy and paste menu to this component.
|
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.
|
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.
|
String[] |
getErrorLabelsList()
Get the list of labels that makes the combo box to be in error status.
|
GLabelWithIndicator |
getGLabelWithIndicator()
Return the GLabel component.
|
GList |
getGList()
Return the GList component.
|
static String |
getLabelForValue(String[] labelsList,
int[] valuesList,
int value)
Return the label associated to the value.
|
List<String> |
getSelectedValues()
Return the list of selected values.
|
GComponent |
getSubComponent(int position)
Gets the subcomponent occupying the position defined by position.
|
String[] |
getWarningLabelsList()
Get the list of labels that makes the combo box to be in warning status.
|
GComponent.CopyPasteOperation |
isCopyPasteEvent(GEvent event)
Checks if the event corresponds to one of the copy and paste menu operations.
|
boolean |
isEnabled()
Gets the enable status of the widget.
|
boolean |
isModified()
Gets the modification status of the component against the last set of values loaded or saved.
|
void |
read()
Implementaion of the routines that allow the component to be loaded from a configuration file.
|
void |
setEnabled(boolean b)
Set the enable status of the component.
|
void |
setErrorLabelsList(String... errorLabels)
Set the list of labels that makes the combo box to be in error status.
|
void |
setSelectedValues(int[] newSelectedIndexes)
Set the selected values of the component from their indexes.
|
void |
setStringConstraint(String constraints)
Set the constraints for the components.
|
void |
setToolTipText(String text)
Set the tooltip text for the entry's label.
|
void |
setWarningLabelsList(String... warningLabels)
Set the list of labels that makes the combo box to be in warning status.
|
void |
setWidgetId(String widgetId)
Sets the widget identifier of the component.
|
protected void |
updateIsModifiedIndicator()
Updates the is modified indicator.
|
void |
updateStatus()
Update the status of the list depending on the selected items.
|
void |
write()
Implementaion of the routines that allow the component to be saved to a configuration file.
|
put
activateConstraintsByType, 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, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setWidth, setWindowBusyCursor, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem
public GListWithLabel()
public GListWithLabel(String label, List<String> data)
label
- to display on the side of the list.data
- text of the different choices.public GListWithLabel(String widgetId, String label)
widgetId
- widget identifier.label
- to display on the side of the list.public void setWidgetId(String widgetId)
setWidgetId
in class GComponent
widgetId
- the widget identifier of the component.public GComponent getSubComponent(int position) throws GComponentException
getSubComponent
in class GComponent
position
- position of the requested component.GComponentException
- in case the position argument is invalid.public void generic() throws GException
generic
in class GContainer
GException
- In case of problem.public void display() throws GException
display
in interface GDisplay
GException
- in case of problem while reading the value from file.public boolean isEnabled()
isEnabled
in class GComponent
public void setEnabled(boolean b)
setEnabled
in class GComponent
b
- new enable status of the component.public boolean isModified()
isModified
in class GComponent
protected final void updateIsModifiedIndicator()
updateIsModifiedIndicator
in class GComponent
public List<String> getSelectedValues()
public void setSelectedValues(int[] newSelectedIndexes)
newSelectedIndexes
- to set.public GLabelWithIndicator getGLabelWithIndicator()
public GList getGList()
public void attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList)
attachCopyPasteMenu
in class GComponent
label
- of the copy&paste menu, if null no label is displayed.operationList
- list of operations to set in the menu. Valid values are Copy if the
"Copy" menu is available, Paste if the "Paste" menu is available, Import if the
"Import" menu is available, and Export if the "Export" menu is available.public static String getLabelForValue(String[] labelsList, int[] valuesList, int value) throws GException
labelsList
- list of labels.valuesList
- list of values.value
- value for which the corresponding label is searched.GException
- in case of empty list of labels, empty list of values,
different length for the lists or value not found in the list
of values.public void read() throws GException
read
in interface GReadWrite
GException
- in case of problem while reading the value from file.public void write() throws GException
write
in interface GReadWrite
GException
- in case of problem while writing the value to file.public void before(GEvent e) throws GException
before
in interface GListener
e
- event to processed.GException
- in case there is a problem managing the event.public void after(GEvent e) throws GException, GFileManipulatorException
after
in interface GListener
e
- processed event.GException
- in case there is a problem managing the event.GFileManipulatorException
public void clear() throws GException
clear
in interface GClear
GException
- in case of problem while clearing the values.public void setToolTipText(String text)
setToolTipText
in class GComponent
text
- the tooltip text for the entry's label.public GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)
isCopyPasteEvent
in class GComponent
event
- to check.public void setStringConstraint(String constraints)
setStringConstraint
in class GComponent
constraints
- to set.public void setErrorLabelsList(String... errorLabels)
errorLabels
- list of labels for error status.public String[] getErrorLabelsList()
public void setWarningLabelsList(String... warningLabels)
warningLabels
- list of labels for warning status.public String[] getWarningLabelsList()
public final void updateStatus()
Copyright © 2024. All rights reserved.