public class GPopupListWithLabel extends GContainer implements GDisplay, GReadWrite, GClear, GListener
GLabelWithIndicator
, and a GPopupList
. The class
implements save and load of selected value in the configuration file.Index | Class | Item | Constraint |
0 | GLabelWithIndicator | label | 0, 0 => "newline , split 2" 0, 1 => (null) |
1 | GPopupList | popupList | (null) |
GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation
NAME_ATTRIBUTE
Constructor and Description |
---|
GPopupListWithLabel()
Constructor by default
|
GPopupListWithLabel(String label,
int selectedRank,
String... menuLabelList)
Constructor.
|
GPopupListWithLabel(String widgetId,
String label,
int selectedRank,
String... menuLabelList)
Constructor.
|
GPopupListWithLabel(String widgetId,
String label,
int selectedRank,
String[] menuLabelList,
String[] toolTipsList)
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.
|
GLabelWithIndicator |
getGLabel()
Get the GLabel component.
|
GPopupList |
getGPopupList()
Get the GPopupList component.
|
int |
getSavedRank()
Get the saved selected rank.
|
GComponent |
getSubComponent(int position)
Gets the subcomponent occupying the position defined by position.
|
int |
getValue()
Get the rank of the selected value in the popup list.
|
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.
|
protected void |
setDefaultConstraints()
Set default constraints.
|
void |
setDefaultValue(int defaultSelectedRank)
Set the new default value.
|
void |
setEnabled(boolean b)
Set the enable status of the component.
|
void |
setSavedRank(int rank)
Set saved selected rank.
|
void |
setStringConstraint(String constraints)
Set the constraint in string format for the component.
|
void |
setTooltipsList(String[] tooltipsList)
Set the list of tooltips associated to each item in the popup list.
|
void |
setToolTipText(String text)
Set the tooltip text for the entry's label.
|
void |
setValue(int rank)
Set the rank of the selected value in the popup list.
|
void |
setWidgetId(String widgetId)
Sets the widget identifier of the component.
|
protected void |
updateIsModifiedIndicator()
Updates the is modified indicator.
|
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, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setWidth, setWindowBusyCursor, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem
public GPopupListWithLabel()
public GPopupListWithLabel(String label, int selectedRank, String... menuLabelList)
label
- text of the label to display.selectedRank
- rank of the selected menu item.menuLabelList
- list of labels of the contextual menu.public GPopupListWithLabel(String widgetId, String label, int selectedRank, String... menuLabelList)
widgetId
- widget identifier.label
- text of the label to display.selectedRank
- rank of the selected menu item.menuLabelList
- list of labels of the contextual menu.public GPopupListWithLabel(String widgetId, String label, int selectedRank, String[] menuLabelList, String[] toolTipsList)
widgetId
- widget identifier.label
- text of the label to display.selectedRank
- rank of the selected menu item.menuLabelList
- list of labels of the contextual menu.toolTipsList
- for the different items.protected final void setDefaultConstraints()
GComponent
setDefaultConstraints
in class GComponent
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
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 int getValue()
public void setValue(int rank)
rank
- of the selected value in the popup list.public GLabelWithIndicator getGLabel()
public GPopupList getGPopupList()
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 boolean isModified()
isModified
in class GComponent
protected final void updateIsModifiedIndicator()
updateIsModifiedIndicator
in class GComponent
public void setSavedRank(int rank)
rank
- new saved rank.public int getSavedRank()
public void setToolTipText(String text)
setToolTipText
in class GComponent
text
- the tooltip text for the entry's label.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 GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)
isCopyPasteEvent
in class GComponent
event
- to check.public void setTooltipsList(String[] tooltipsList)
tooltipsList
- the list of tooltips from the popup list items.public void setStringConstraint(String constraints)
setStringConstraint
in class GComponent
constraints
- constraint in string format to set for the component.public void setDefaultValue(int defaultSelectedRank)
defaultSelectedRank
- new rank of the item selected by default (starting from 0).Copyright © 2024. All rights reserved.