Class GomToggle
java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
de.espirit.firstspirit.access.store.templatestore.gom.GomToggle
- All Implemented Interfaces:
GomCheckable
,GomElement
,GomFormElement
,GomHideable
,GomLangInfoProvider
,GomSearchRelevancy
,GomSingleLineable
,LineBreakable
,Serializable
Field to toggle between on and off state
- Since:
- 4.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable
GomCheckable.Context
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreates a clone of this instanceprotected String
Return the default tag for a gom element.Defines whether to hide the component's label@NotNull DefaultGomLangInfos
getOff()
Language-dependent information for off state@NotNull DefaultGomLangInfos
getOn()
Language-dependent information for on stateIndicates if the component is single-line instead of being framedgetType()
Display type for statesboolean
Convenience API forgetHideLabel()
returning a boolean valuevoid
setHideLabel
(YesNo hideLabel) Sets whether to hide the component's labelvoid
setSingleLine
(YesNo singleLine) Make the component be single-line instead of being framedvoid
setType
(ToggleType type) Sets the display type for statesboolean
Convenience API forgetSingleLine()
returning a boolean value@NotNull ToggleType
type()
Convenience API forgetType()
returning a non-null valueMethods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, validate, verify
Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
-
Field Details
-
TAG
The tag of this component- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
GomToggle
public GomToggle()
-
-
Method Details
-
getDefaultTag
Description copied from class:AbstractGomElement
Return the default tag for a gom element.- Specified by:
getDefaultTag
in classAbstractGomElement
- Returns:
- The elements default tag.
-
getOn
Language-dependent information for on state- Since:
- 4.0
-
getOff
Language-dependent information for off state- Since:
- 4.0
-
getType
Display type for states- Since:
- 4.0
-
setType
Sets the display type for states- Since:
- 4.0
-
getHideLabel
Defines whether to hide the component's label- Since:
- 4.0
-
setHideLabel
Sets whether to hide the component's label- Since:
- 4.0
-
getSingleLine
Indicates if the component is single-line instead of being framed- Since:
- 4.0
-
setSingleLine
Description copied from interface:GomSingleLineable
Make the component be single-line instead of being framed- Specified by:
setSingleLine
in interfaceGomSingleLineable
-
cloneInstance
Creates a clone of this instance- Since:
- 5.0
-
type
Convenience API forgetType()
returning a non-null value- Returns:
- the value of
getType()
orToggleType.CHECKBOX
if unset - Since:
- 4.0
-
hideLabel
public boolean hideLabel()Convenience API forgetHideLabel()
returning a boolean value- Since:
- 4.0
-
singleLine
public boolean singleLine()Convenience API forgetSingleLine()
returning a boolean value- Since:
- 4.0
-