Interface ModifiableRepeater
-
- All Superinterfaces:
Repeater
- All Known Implementing Classes:
ModifiableModelAwareRepeater
public interface ModifiableRepeater extends Repeater
Interface for modifiable repeaters
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ModifiableRepeaterEntryaddEntry()Creates a Repeater entry at the last position.ModifiableRepeaterEntryaddEntry(int position)Creates a Repeater entry at the given position.ModifiableRepeaterEntrygetEntry(int position)Retrieves the repeater entry at the given position.ModifiableDataHoldergetParentDataHolder()Retrieves the parent of the currentRepeaterModifiableRepositoryDatagetRepositoryData()Retrieves the repository data used by thisRepeaterModifiableDataHoldergetRootDataHolder()Retrieves the rootDataHolderof the current repeaterbooleanmoveEntries(Map<Integer,Integer> positionsMapping, int targetSize)Moves the entries according to the given position mapping.voidremoveEntries(Set<Integer> positions)Removes the repeater entries at the given positions.voidremoveEntry(int position)Removes the repeater entry at the given position.
-
-
-
Method Detail
-
getEntry
ModifiableRepeaterEntry getEntry(int position)
Description copied from interface:RepeaterRetrieves the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to get an entry from the beginning Or the position can an integer between 0 and - the repeater size to get an entry from the end (0 means at the end, -1 means before the last one and so on)
-
addEntry
ModifiableRepeaterEntry addEntry()
Creates a Repeater entry at the last position.- Returns:
- the created entry
-
addEntry
ModifiableRepeaterEntry addEntry(int position) throws IllegalArgumentException
Creates a Repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size + 1 to insert an entry from the beginning Or the position can an integer between 0 and - the repeater size to insert an entry from the end (0 means at the end, -1 means before the last one and so on)- Parameters:
position- The position of the new entry- Returns:
- the created entry
- Throws:
IllegalArgumentException- if the position is not between the negative and positive repeater size
-
moveEntries
boolean moveEntries(Map<Integer,Integer> positionsMapping, int targetSize)
Moves the entries according to the given position mapping. The given position mapping's key is the previous position and the value is the new one The existent entries with no corresponding entry in the position mapping will be removed the given size is taken into account to create new empty entries if needed- Parameters:
positionsMapping- the position mappingtargetSize- the target size of the repeater- Returns:
trueif some entries have moved,falseotherwise
-
removeEntries
void removeEntries(Set<Integer> positions) throws UnknownDataException
Removes the repeater entries at the given positions. The position starts at index 1. The positions can be integers between 1 and the repeater size to remove an entry from the beginning Or the positions can integers between 0 and - the repeater size to remove an entry from the end (0 means the last entry, -1 means before the last one and so on)- Parameters:
positions- The positions of the entries to remove- Throws:
UnknownDataException- if there is no entry for one of the given positions
-
removeEntry
void removeEntry(int position) throws UnknownDataException
Removes the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to remove an entry from the beginning Or the position can an integer between 0 and - the repeater size to remove an entry from the end (0 means the last entry, -1 means before the last one and so on)- Parameters:
position- The position of the entry to remove- Throws:
UnknownDataException- if there is no entry at the given position
-
getRepositoryData
ModifiableRepositoryData getRepositoryData()
Description copied from interface:RepeaterRetrieves the repository data used by thisRepeater- Specified by:
getRepositoryDatain interfaceRepeater- Returns:
- the repository data used by this
Repeater
-
getParentDataHolder
ModifiableDataHolder getParentDataHolder()
Description copied from interface:RepeaterRetrieves the parent of the currentRepeater- Specified by:
getParentDataHolderin interfaceRepeater- Returns:
- the parent of the current
Repeater
-
getRootDataHolder
ModifiableDataHolder getRootDataHolder()
Description copied from interface:RepeaterRetrieves the rootDataHolderof the current repeater- Specified by:
getRootDataHolderin interfaceRepeater- Returns:
- the root
DataHolder
-
-