|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ListType
This interface defines a JAXFront ListType. A ListType manages a list of other types which can be either of the types ComplexGroup, SimpleGroup or SimpleType.
Field Summary | |
---|---|
static int |
VALIDATE_ADD
|
static int |
VALIDATE_DELETE
|
static int |
VALIDATE_NOCHANGE
|
Fields inherited from interface com.jaxfront.core.type.Type |
---|
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType |
Method Summary | |
---|---|
Type |
add(Type type)
Adds a new type to the list. |
Type |
addNewChild()
Adds a new child to the list. |
Type |
addNewChild(int index)
|
Type |
addNewChild(Type template)
Adds a new child to the list. |
Type |
addNewChild(Type templateType,
int targetIndex)
Copies the given templateType and adds it to the list at the given index position. |
void |
addNoTargetXUIDefinition(Type xuiType)
Adds an information to a XUI type if a list doesn't contain any types for which a XUI definition would exist. |
void |
autoCreateEntries()
Create the initial number of required min occur list items. |
void |
bind(Document DOM,
org.w3c.dom.Element instanceElement,
boolean bindOnlyAvailable,
boolean removeChilds)
|
void |
checkCardinality(int changes)
Checks if removing or adding a new list entry violates the cardinality. |
void |
copyAndPasteChild(java.lang.Integer typeToCopyIndex,
java.lang.Integer targetIndex)
|
void |
copyAndPasteChild(Type typeToCopy)
|
void |
copyAndPasteChild(Type typeToCopy,
java.lang.Integer targetIndex)
|
Type |
copyChild(java.lang.Integer index)
Copies the child with the given index and returns it. |
java.lang.Object |
delete(Type type)
Deletes a type from the list. |
Type |
getEditingType()
Gets the current editable type of the list. |
java.util.List |
getList()
Gets the list of types. |
int |
getMaxOccurs()
Returns the maximum number of allowed list entries. |
int |
getMinOccurs()
Returns the minimum number of allowed list entries. |
int[] |
getSortIndexes()
Returns the sort indexes or null. |
boolean |
isListItemRemoveable(Type type)
|
void |
maintainXUIDefinitions(Type type)
Traverses down the editing type and maintains all the xui definitions set on the editing type axis to the passed type. |
void |
move(int from,
int to)
Deprecated. use swap |
void |
removeAll(boolean isTemporary,
boolean checkCardinality)
Removes all childs of the list. |
java.lang.Object |
removeChild(int index)
Removes the list item with the given index from the list. |
java.lang.Object |
removeLastChild(boolean temporary)
Removes the last list item from the list. |
void |
removeNoTargetXUIDefinition(Type xuiType)
Removes an information of a XUI type if a list doesn't contain any types for which a XUI definition would exist. |
void |
setEditingType(Type editingType)
Resets the editing type. |
void |
setList(java.util.List list)
Sets the list entries. |
void |
setSortIndexes(int[] sortIndexes)
Set the sort indexes. |
void |
swap(int from,
int to)
Swaps the position of two given types in the list |
boolean |
violateCardinality(int changes)
Checks if removing or adding a new list entry violates the cardinality. |
Methods inherited from interface java.util.List |
---|
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray |
Field Detail |
---|
static final int VALIDATE_NOCHANGE
static final int VALIDATE_ADD
static final int VALIDATE_DELETE
Method Detail |
---|
Type add(Type type)
type
- a new type to add
Type addNewChild()
Type addNewChild(int index)
Type addNewChild(Type templateType, int targetIndex)
templateType
- the child to be cloned or null if nonetargetIndex
- the index where to copy should be placed in the list
Type addNewChild(Type template)
template
- the child to be added to the list
void bind(Document DOM, org.w3c.dom.Element instanceElement, boolean bindOnlyAvailable, boolean removeChilds)
void addNoTargetXUIDefinition(Type xuiType)
xuiType
- the type for which a XUI definition exists but no subtypes
were createdjava.lang.Object delete(Type type) throws ListModificationException
type
- the type to delete
ListModificationException
Type getEditingType()
java.util.List getList()
void removeAll(boolean isTemporary, boolean checkCardinality)
isTemporary
- indicates if this deletion is temporarycheckCardinality
- indicates if cardinality violation should be checkedvoid removeNoTargetXUIDefinition(Type xuiType)
xuiType
- the type for which a XUI definition exists but no subtypes
were createdvoid setList(java.util.List list)
list
- list entriesint getMaxOccurs()
int getMinOccurs()
void checkCardinality(int changes) throws ValidationException
changes
- number of new list entries
ValidationException
boolean violateCardinality(int changes)
changes
- number of new list entriesint[] getSortIndexes()
void setSortIndexes(int[] sortIndexes)
sortIndexes
- new sort index arrayjava.lang.Object removeChild(int index) throws ListModificationException
index
- the index of the list item to should be removed from the list
ListModificationException
java.lang.Object removeLastChild(boolean temporary) throws ListModificationException
temporary
- indicates if the deletion is temporary
ListModificationException
Type copyChild(java.lang.Integer index)
typeToCopyIndex
- the index of the child that should be copiedvoid copyAndPasteChild(java.lang.Integer typeToCopyIndex, java.lang.Integer targetIndex)
void copyAndPasteChild(Type typeToCopy, java.lang.Integer targetIndex)
void copyAndPasteChild(Type typeToCopy)
void maintainXUIDefinitions(Type type)
void swap(int from, int to)
from
- the source positionto
- the destination positionvoid move(int from, int to)
from
- the source positionto
- the destination positionvoid setEditingType(Type editingType)
editingType
- template type for a listvoid autoCreateEntries()
boolean isListItemRemoveable(Type type) throws ListModificationException
ListModificationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |