Package de.esoco.data.element
Klasse DateListDataElement
java.lang.Object
de.esoco.lib.property.AbstractStringProperties
de.esoco.lib.property.StringProperties
- Alle implementierten Schnittstellen:
de.esoco.lib.model.DataModel<DateDataElement>
,de.esoco.lib.property.HasProperties
,de.esoco.lib.property.MutableProperties
,Serializable
,Iterable<DateDataElement>
A data element that holds a list of date values and associated data in
instances of
DateDataElement
. The properties of the data elements can
be used to transfer additional- Siehe auch:
-
Verschachtelte Klassen - Übersicht
Modifizierer und TypKlasseBeschreibungstatic enum
Enumeration of the possible edit types that can occur in interactions for the child elements.static enum
Enumeration of the display types for time the rendering in a Timetable component.Von Klasse geerbte verschachtelte Klassen/Schnittstellen de.esoco.data.element.DataElement
DataElement.CopyMode, DataElement.Flag
-
Feldübersicht
Modifizierer und TypFeldBeschreibungstatic final de.esoco.lib.property.PropertyName
<DateListDataElement.InteractionType> The type of the interaction event that occurred on a child.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the first hour to display in DAY views.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the number of days to display withDateListDataElement.TimetableDisplayStyle.DAY
.static final de.esoco.lib.property.PropertyName
<DateListDataElement.TimetableDisplayStyle> UI property: the style in which to render a Timetable display.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the first working hour in DAY views.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the size in pixels of hour subdivisions in DAY views.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the number of hour subdivisions in DAY views.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the last working hour in DAY views.static final de.esoco.lib.property.PropertyName
<Integer> UI property: the first hour to display in DAY or AGENDA views.static final de.esoco.lib.property.PropertyName
<Boolean> UI property: TRUE to display week numbers.Von Klasse geerbte Felder de.esoco.data.element.DataElement
ALLOWED_VALUES_CHANGED, ANONYMOUS_ELEMENT_PREFIX, DISPLAY_FLAGS, HIDDEN_URL, INPUT_FLAGS, INTERACTION_URL, ITEM_ALL_RESOURCE, ITEM_NEW_RESOURCE, ITEM_RESOURCE_PREFIX, PATH_SEPARATOR_CHAR, SERVER_PROPERTIES
-
Konstruktorübersicht
ModifiziererKonstruktorBeschreibungprotected
Default constructor for serialization.DateListDataElement
(String name, Collection<DateDataElement> elements) Creates a new instance. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungcopy
(DataElement.CopyMode mode, de.esoco.lib.property.PropertyName<?>... copyProperties) Returns a copy of this data element that contains all or a subset of it's current state.final de.esoco.lib.property.HasProperties
Returns the properties containing the data resulting from an interaction.Returns the type of an interaction that occurred.protected List
<DateDataElement> getList()
Returns the list of values of this data element.final de.esoco.lib.property.HasProperties
Returns the properties object for the currently selected element.static void
init()
This method should be invoked to initialize the property name constants for de-serialization.protected DateListDataElement
Returns a new instance of the respective data element sub-type on which it is invoked.final void
setInteraction
(DateListDataElement.InteractionType type, de.esoco.lib.property.HasProperties data) Sets the type of an interaction that occurred and the associated data.final void
setSelection
(de.esoco.lib.property.HasProperties selection) Returns the properties object for the currently selected element.protected void
updateValue
(List<DateDataElement> newElements) Updates the element value.Von Klasse geerbte Methoden de.esoco.data.element.ListDataElement
addAll, addAllowedValues, addElement, addElement, clear, containsElement, copyValue, getAllowedValues, getElement, getElementCount, getElementIndex, getElements, getElementValidator, getValue, getValueHashCode, hasEqualValueAs, iterator, removeElement, toString
Von Klasse geerbte Methoden de.esoco.data.element.DataElement
checkImmutable, checkValidValue, copyAttributes, createItemName, createItemResource, createResourceId, equals, getName, getParent, getPath, getResourceId, getRoot, getSimpleName, getValidator, hashCode, isImmutable, isModified, isOptional, isSelected, isValidValue, markAsChanged, readFrom, removeProperty, setModified, setProperty, setSelected, setStringValue, setValidator, setValue, toDebugString, valuesEqual, writeTo
Von Klasse geerbte Methoden de.esoco.lib.property.StringProperties
clearFlag, clearProperties, setFlag, setProperties, setProperty, setProperty
Von Klasse geerbte Methoden de.esoco.lib.property.AbstractStringProperties
convertCollection, convertMap, convertValue, ensurePropertyMapExists, findValue, getIntProperty, getProperty, getPropertyCount, getPropertyMap, getPropertyNames, hasEqualProperties, hasFlag, hasProperty, parseCollection, parseMap, parseValue, setPropertyMap
Von Klasse geerbte Methoden java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Von Schnittstelle geerbte Methoden de.esoco.lib.property.HasProperties
getIntProperty, getProperty, getPropertyCount, getPropertyNames, hasFlag, hasProperty
Von Schnittstelle geerbte Methoden java.lang.Iterable
forEach, spliterator
-
Felddetails
-
INTERACTION_TYPE
public static final de.esoco.lib.property.PropertyName<DateListDataElement.InteractionType> INTERACTION_TYPEThe type of the interaction event that occurred on a child. -
TIMETABLE_DISPLAY_STYLE
public static final de.esoco.lib.property.PropertyName<DateListDataElement.TimetableDisplayStyle> TIMETABLE_DISPLAY_STYLEUI property: the style in which to render a Timetable display. -
TIMETABLE_DAYS
UI property: the number of days to display withDateListDataElement.TimetableDisplayStyle.DAY
. -
TIMETABLE_DAY_START
UI property: the first hour to display in DAY views. -
TIMETABLE_FIRST_WORKING_HOUR
UI property: the first working hour in DAY views. -
TIMETABLE_LAST_WORKING_HOUR
UI property: the last working hour in DAY views. -
TIMETABLE_SCROLL_TO_HOUR
UI property: the first hour to display in DAY or AGENDA views. -
TIMETABLE_HOUR_SUBDIVISIONS
UI property: the number of hour subdivisions in DAY views. -
TIMETABLE_HOUR_SUBDIVISION_HEIGHT
UI property: the size in pixels of hour subdivisions in DAY views. -
TIMETABLE_SHOW_WEEK_NUMBERS
UI property: TRUE to display week numbers.
-
-
Konstruktordetails
-
DateListDataElement
Creates a new instance.- Parameter:
name
- The name of this elementelements
- The date data
-
DateListDataElement
protected DateListDataElement()Default constructor for serialization.
-
-
Methodendetails
-
init
public static void init()This method should be invoked to initialize the property name constants for de-serialization. -
copy
public DateListDataElement copy(DataElement.CopyMode mode, de.esoco.lib.property.PropertyName<?>... copyProperties) Returns a copy of this data element that contains all or a subset of it's current state. Always copied are the name andflags
. Never copied is the parent reference because upon copying typically a reference to a copied parent needs to be set. The further data the copy contains depends on the copy mode:DataElement.CopyMode.FULL
: The copy contains all data (except the parent reference).DataElement.CopyMode.FLAT
: likeDataElement.CopyMode.FULL
but without sub-ordinate data elements.DataElement.CopyMode.PROPERTIES
: The copy contains only the properties but not the element value and attributes.DataElement.CopyMode.PLACEHOLDER
: The copy contains only the element name to serve as a placeholder.
The copy instance is created by invoking
DataElement.newInstance()
which has the recommendation to overwrite the return type to the concrete subtype to prevent the need for casting by the invoking code. For the same reason it is recommended that subclasses also override this method with the concrete return type and cast the result ofsuper.copy()
to that type.- Setzt außer Kraft:
copy
in KlasseDataElement<List<DateDataElement>>
- Parameter:
mode
- The copy modecopyProperties
- An optional list of properties to copy. If not provided all properties will be copied (unless the mode isDataElement.CopyMode.PLACEHOLDER
)- Gibt zurück:
- The copied instance
-
getInteractionData
public final de.esoco.lib.property.HasProperties getInteractionData()Returns the properties containing the data resulting from an interaction. If the interaction is caused by the editing of an existing child of this instance the returned object will be the corresponding child element. Otherwise the returned object will contain the respective data for the interaction type.- Gibt zurück:
- The interaction data
- Siehe auch:
-
getInteractionType
Returns the type of an interaction that occurred. Depending on the interaction type the methodgetInteractionData()
will return a different kind of data object:- Gibt zurück:
- The interaction type
-
getSelection
public final de.esoco.lib.property.HasProperties getSelection()Returns the properties object for the currently selected element.- Gibt zurück:
- The selection properties or NULL for none
-
setInteraction
public final void setInteraction(DateListDataElement.InteractionType type, de.esoco.lib.property.HasProperties data) Sets the type of an interaction that occurred and the associated data.- Parameter:
type
- The type of interaction that occurreddata
- The properties containing the interaction-specific data
-
setSelection
public final void setSelection(de.esoco.lib.property.HasProperties selection) Returns the properties object for the currently selected element.- Parameter:
selection
- The selection properties or NULL for none
-
getList
Returns the list of values of this data element. Must be implemented by subclasses to return the type-specific value list.- Angegeben von:
getList
in KlasseListDataElement<DateDataElement>
- Gibt zurück:
- The list of values for this instance (must not be NULL)
-
newInstance
Returns a new instance of the respective data element sub-type on which it is invoked. This is needed for GWT which doesn't support reflection. Used byDataElement.copy(CopyMode, PropertyName...)
for cloning an instance. Implementations should overwrite the return type with their concrete type to prevent the need for casting by the invoking code.- Angegeben von:
newInstance
in KlasseDataElement<List<DateDataElement>>
- Gibt zurück:
- The new instance
-
updateValue
Updates the element value. Will be invoked byDataElement.setValue(Object)
to store a new value after validation. If a subclass wants to reject certain values it should do so in theDataElement.isValidValue(Validator, Object)
method. Subclasses that are always immutable should implement an assertion because if the element has been initialized correctly (validator = NULL) this method should then be reached.- Angegeben von:
updateValue
in KlasseDataElement<List<DateDataElement>>
- Parameter:
newElements
- The new value for this element
-