public class GCheckBoxWithIndicator extends GContainer implements GDisplay, GReadWrite, GListener, GClear
Index | Class | Item | Constraint |
0 | GLabelWithIndicator | label | 0, 0 => "newline , split 2" 0, 1 => (null) |
1 | GCheckBox | checkbox | (null) |
GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation
NAME_ATTRIBUTE
Constructor and Description |
---|
GCheckBoxWithIndicator()
Constructor by default
|
GCheckBoxWithIndicator(String label,
boolean isSelected)
Constructor.
|
GCheckBoxWithIndicator(String widgetId,
String label,
boolean isSelected)
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 |
getCommentInConfigFile()
Gets the comment to be set in the configuration file.
|
boolean |
getDefaultValue()
Get the default value of the checkBox.
|
GCheckBox |
getGCheckBox()
Return the GCheckBox component.
|
GLabelWithIndicator |
getGLabelWithIndicator()
Return the GLabel component.
|
String |
getNameInConfigFile()
Get the name to be used when saving the component in the configuration file.
|
boolean |
getSavedValue()
Get the saved value.
|
GComponent |
getSubComponent(int position)
Gets the subcomponent occupying the position defined by position.
|
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.
|
boolean |
isSelected()
Checks if the checkbox is selected.
|
void |
read()
Implementaion of the routines that allow the component to be loaded from a configuration file.
|
void |
setCommentInConfigFile(String text)
Sets the comment to be set in the configuration file.
|
void |
setDefaultValue(boolean value)
Change the default value of the checkBox.
|
void |
setEnabled(boolean b)
Set the enable status of the component.
|
void |
setNameInConfigFile(String text)
Sets the name to be used when saving the component in the configuration file.
|
void |
setSavedValue(boolean value)
Change the saved value.
|
void |
setSelected(boolean b)
Set the selection status of the widget.
|
void |
setStringConstraint(String constraints)
Set the constraints for the components.
|
void |
setToolTipText(String text)
Set the tooltip text for the entry's label.
|
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, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setPathInConfigFile, setStatus, setWidth, setWindowBusyCursor, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem
public GCheckBoxWithIndicator()
public GCheckBoxWithIndicator(String label, boolean isSelected)
label
- to display on the side of the checkbox.isSelected
- if true, the checkbox will be selected or not, otherwise.public GCheckBoxWithIndicator(String widgetId, String label, boolean isSelected)
widgetId
- widget identifier.label
- to display on the side of the checkbox.isSelected
- if true, the checkbox will be selected or not, otherwise.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 GLabelWithIndicator getGLabelWithIndicator()
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 GCheckBox getGCheckBox()
public void setToolTipText(String text)
setToolTipText
in class GComponent
text
- the tooltip text for the entry's label.public boolean isSelected()
public void setSelected(boolean b)
b
- true if the checkbox is selected, false otherwise.public void setDefaultValue(boolean value)
value
- default value to set.public boolean getDefaultValue()
public void setSavedValue(boolean value)
value
- new saved value.public boolean getSavedValue()
protected void updateIsModifiedIndicator()
updateIsModifiedIndicator
in class GComponent
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 void read() throws GException
GReadWrite
read
in interface GReadWrite
GException
- in case of problem while reading the value from file.public void write() throws GException
GReadWrite
write
in interface GReadWrite
GException
- in case of problem while writing the value to file.public void before(GEvent e) throws GException
GListener
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
GListener
after
in interface GListener
e
- processed event.GException
- in case there is a problem managing the event.GFileManipulatorException
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()
GComponent
isModified
in class GComponent
public void clear() throws GException
GClear
clear
in interface GClear
GException
- in case of problem while clearing the values.public void setStringConstraint(String constraints)
setStringConstraint
in class GComponent
constraints
- to set.public final void setNameInConfigFile(String text)
setNameInConfigFile
in class GComponent
text
- to be used when saving the component in the configuration file.public String getNameInConfigFile()
getNameInConfigFile
in class GComponent
public final void setCommentInConfigFile(String text)
setCommentInConfigFile
in class GComponent
text
- to be set in the configuration file.public String getCommentInConfigFile()
getCommentInConfigFile
in class GComponent
Copyright © 2024. All rights reserved.