XMLCollection (onecode-esdstudio 1.1.2 API)

java.lang.Object
- com.ds.bpm.bpd.xml.XMLElement
- - com.ds.bpm.bpd.xml.XMLCollection

所有已实现的接口:

Serializable, Cloneable

直接已知子类:

Activities, ActivityButtons, ActivitySets, ActualParameters, Applications, AttachmentButtons, AttachmentDefs, CommandListeners, CommonAttributeTableButtons, CommonExAttributes, DataFields, Deadlines, Devices, EnumerationType, Events, ExtendedAttributes, ExternalPackages, FormalParameters, Forms, Formulas, Listeners, MDForms, Namespaces, Participants, ProcessCommissions, RecordType, Responsibles, RightGroups, Services, Tables, Tools, TransitionRefs, TransitionRestrictions, Transitions, TypeDeclarations, UnionType, UserProperties, UserPropertyRefs, WebWordButtons, WorkflowProcesses
```
public class XMLCollection
extends XMLElement
```
XMLCollection class instance represents program equivalence to the collection of elements defined in some XML XML. It is used to enable user to visually create new element and put it into collection, and also to edit it and modify.
NOTE: Although this class is not declared abstract, it is uselles without redefining it's methods (especially generateNewElement() method}.

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected XMLPanel`	`controlledPanel` Visually presents the collection of elements.
`protected XMLControlPanel`	`controlPanel` The panel consisted of control buttons.
`protected String`	`IDPrefix` Used as a textual prefix for a generated numerical ID
`protected XMLComplexElement`	`myOwner` The owner class which element is this class instance.
`protected ArrayList`	`refCollectionElements` The collection of elements.

从类继承的字段 com.ds.bpm.bpd.xml.XMLElement
atts, isCollapsed, isReadOnly, isRequired, isVisible, labelName, name, NEWLINE, OFFSET, value

构造器概要

构造器
构造器和说明
`XMLCollection(XMLComplexElement myOwner)` Create collection which is owned by specified owner.
`XMLCollection(XMLComplexElement myOwner, String name)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(XMLElement el)` Adds new element to collection.
`boolean`	`canInsertElement(XMLElement el)` Returns `true` if element can be inserted into collection.
`boolean`	`canRemoveElement(XMLElement el)` Returns `true` if element can be removed from collection.
`void`	`clear()` Clears the collection.
`Object`	`clone()` Used to create exact copy of instance of this class.
`protected void`	`decrementID()` Decrements an ID.
`void`	`fromXML(Node node)` Supposed to be overriden by derived classes to implement element specific reading from an XML file.
`String`	`generateID()` Generates numerical ID for elements that need it, and converts that ID to string by adding it a prefix that is set using #setIDPrefix method.
`XMLElement`	`generateNewElement()` Generates the new element that made collection.
`Object`	`get(int no)` Gets the element that is placed at specified no. from collection.
`Collection`	`getChoosable()` Gets elements that can be choosed within some combo box.
`XMLComplexElement`	`getCollectionElement(String IDOrName)` Returnes the element specified by ID or Name attribute.
`XMLPanel`	`getControlledPanel()`
`XMLPanel`	`getControlPanel()`
`long`	`getCurrentID()` Gets the ID upon further IDs are generated.
`DefaultCellEditor`	`getEditableDefaultValue(int column)`
`int[]`	`getEditableTableFieldOrdinals()`
`Collection`	`getElementStructure()` Gets the structure of elements contained within collection, that is the all elements that element is made of.
`String`	`getIDPrefix()` Returns the prefix of some ID generated by #generateID.
`String`	`getInUseMessageName(XMLComplexElement el)` Returns the name of the message defined within property file that explains the reason why element that is in use can't be deleted.
`int[]`	`getInvisibleTableFieldOrdinals()` Returns the ordinal numbers of elements not to be displayed within table panel.
`JList`	`getJList()`
`DefaultMutableTreeNode`	`getNode()` Make tree node for this element and all subelements.
`XMLComplexElement`	`getOwner()`
`XMLPanel`	`getPanel()` Returns the panel for editing the element.
`String`	`getReadOnlyMessageName(XMLComplexElement el)` Returns the name of the message defined within property file that explains the reason why element marked as read only can't be deleted.
`Collection`	`getTableElements()` Gets elements that can be choosed within table.
`Collection`	`getValues()`
`DefaultMutableTreeNode`	`getXPDLNode()`
`boolean`	`isEmpty()` Returns `true` if there is no elements within collection.
`static boolean`	`isIdValid(String id)` Checks if Id is valid NMTOKEN string.
`boolean`	`isJCheckBox(int column)`
`void`	`onElementCreated(XMLElement el)` Some specific things to be done after element is created.
`void`	`onElementDeleted(XMLElement el)` Some specific things to be done after element is deleted from collection.
`void`	`onElementInserted(XMLElement el)` Some specific things to be done after element is inserted. into collection.
`void`	`onElementModified(XMLElement el)` Some specific things to be done after element from collection is modified.
`void`	`onElementRemoved(XMLElement el)` Some specific things to be done after element is removed from collection.
`void`	`refreshCollection(Set elementsToAddOrRemove, boolean append)` Refreshes the collection.
`void`	`refreshLabelName()`
`void`	`remove(Object el)` Removes specified element from collection.
`protected void`	`resetID()` Resets an ID generator.
`protected void`	`setCurrentID(long ID)` Sets the ID upon further IDs are generated.
`void`	`setIDPrefix(String idPref)` Sets the prefix for some ID generated by #generateID.
`void`	`setOwner(XMLComplexElement myOwner)`
`void`	`setReadOnly(boolean ro)` Sets the collection and all contained elements to be read only or not.
`int`	`size()` Returns the number of elements within collection.
`Collection`	`toCollection()` Returns the collection of all elements within collection.
`String`	`toString()` Returns the text representation of element's 'value'.
`void`	`toXML(Node parent)` Supposed to be overriden by derived classes to implement element specific writting to an XML file.
`protected void`	`updateID(String someID)` Updates an ID.

从类继承的方法 com.ds.bpm.bpd.xml.XMLElement
fromXML, getPrintDescription, getPrintDescription, isCollapsed, isReadOnly, isRequired, isValid, isValidEnter, isVisible, setCollapsed, setLabelName, setRequired, setValue, setVisible, toLabel, toName, toValue

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - IDPrefix
```
protected transient String IDPrefix
```
    Used as a textual prefix for a generated numerical ID
  - refCollectionElements
```
protected transient ArrayList refCollectionElements
```
    The collection of elements.
  - controlledPanel
```
protected transient XMLPanel controlledPanel
```
    Visually presents the collection of elements. The default panel is instance of XMLTablePanel class.
  - controlPanel
```
protected transient XMLControlPanel controlPanel
```
    The panel consisted of control buttons. It controls the process of adding, deleting and modifying the elements of collection. The default panel is instance of XMLTableControlPanel class.
  - myOwner
```
protected transient XMLComplexElement myOwner
```
    The owner class which element is this class instance.
- 构造器详细资料
  - XMLCollection
```
public XMLCollection(XMLComplexElement myOwner)
```
    Create collection which is owned by specified owner.
    
    参数:
    
    myOwner - the program equivalence to an XML schema defined element that holds the XML schema collection presented by this class instance.
  - XMLCollection
```
public XMLCollection(XMLComplexElement myOwner,
                     String name)
```
- 方法详细资料
  - getOwner
```
public XMLComplexElement getOwner()
```
  - add
```
public void add(XMLElement el)
```
    Adds new element to collection.
  - remove
```
public void remove(Object el)
```
    Removes specified element from collection.
  - get
```
public Object get(int no)
```
    Gets the element that is placed at specified no. from collection.
  - size
```
public int size()
```
    Returns the number of elements within collection.
  - clear
```
public void clear()
```
    Clears the collection.
  - refreshCollection
```
public void refreshCollection(Set elementsToAddOrRemove,
                              boolean append)
```
    Refreshes the collection.
    
    参数:
    
    elementsToAddOrRemove - Set of elements that has to be added to or removed from collection.
    
    append - true if adding elements to collection, false otherwise.
  - getCollectionElement
```
public XMLComplexElement getCollectionElement(String IDOrName)
```
    Returnes the element specified by ID or Name attribute. If this is collection of XMLCollectionElement objects, element is searched by ID attribute, otherwise it is searched by Name attribute.
    
    参数:
    
    IDOrName - ID or Name attribute of wanted element.
    
    返回:
    
    Wanted element if exist, null otherwise.
  - getElementStructure
```
public Collection getElementStructure()
```
    Gets the structure of elements contained within collection, that is the all elements that element is made of.
  - getInvisibleTableFieldOrdinals
```
public int[] getInvisibleTableFieldOrdinals()
```
    Returns the ordinal numbers of elements not to be displayed within table panel. The ordinal numbers of elements corresponds to the inserting order within XMLComplexElement.fillStructure() method.
  - setReadOnly
```
public void setReadOnly(boolean ro)
```
    Sets the collection and all contained elements to be read only or not.
    
    覆盖:
    
    setReadOnly 在类中 XMLElement
    
    参数:
    
    ro - true if element will be 'read only', false otherwise.
  - toCollection
```
public Collection toCollection()
```
    Returns the collection of all elements within collection.
  - getTableElements
```
public Collection getTableElements()
```
    Gets elements that can be choosed within table. Default implementation returns all elements within collection.
  - getChoosable
```
public Collection getChoosable()
```
    Gets elements that can be choosed within some combo box. Default implementation returns all elements within collection.
  - generateNewElement
```
public XMLElement generateNewElement()
```
    Generates the new element that made collection. Derived classes has to implement this method to create it's collection element.
  - onElementCreated
```
public void onElementCreated(XMLElement el)
```
    Some specific things to be done after element is created. Default implementation is nothing to do, and derived classes should implement it's specific actions.
  - onElementInserted
```
public void onElementInserted(XMLElement el)
```
    Some specific things to be done after element is inserted. into collection. Default implementation is nothing to do, and derived classes should implement it's specific actions.
  - onElementModified
```
public void onElementModified(XMLElement el)
```
    Some specific things to be done after element from collection is modified. Default implementation is nothing to do, and derived classes should implement it's specific actions.
  - onElementDeleted
```
public void onElementDeleted(XMLElement el)
```
    Some specific things to be done after element is deleted from collection. Default implementation is nothing to do, and derived classes should implement it's specific actions.
  - onElementRemoved
```
public void onElementRemoved(XMLElement el)
```
    Some specific things to be done after element is removed from collection. Default implementation is nothing to do, and derived classes should implement it's specific actions.
  - canInsertElement
```
public boolean canInsertElement(XMLElement el)
```
    Returns true if element can be inserted into collection. Default implementation returns true, and derived classes should implement it's specific check.
  - canRemoveElement
```
public boolean canRemoveElement(XMLElement el)
```
    Returns true if element can be removed from collection. Default implementation returns true, and derived classes should implement it's specific check.
  - getControlledPanel
```
public XMLPanel getControlledPanel()
```
  - getControlPanel
```
public XMLPanel getControlPanel()
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if there is no elements within collection.
    
    覆盖:
    
    isEmpty 在类中 XMLElement
    
    返回:
    
    true if user haven't defined the element value within dialog, false otherwise.
  - getPanel
```
public XMLPanel getPanel()
```
    从类复制的说明: XMLElement
    
    Returns the panel for editing the element. This implementation returns an empty basic panel, the derived classes should implement this method to suite their needs. 得到该XML元素展示的Panel
    
    覆盖:
    
    getPanel 在类中 XMLElement
    
    返回:
    
    A panel to put into dialog for editing element.
  - toXML
```
public void toXML(Node parent)
           throws DOMException
```
    从类复制的说明: XMLElement
    
    Supposed to be overriden by derived classes to implement element specific writting to an XML file. 把值对象格式化成XML元素
    
    覆盖:
    
    toXML 在类中 XMLElement
    
    参数:
    
    parent - indicates how much tabulators to put before element tag.
    
    抛出:
    
    DOMException
  - fromXML
```
public void fromXML(Node node)
```
    从类复制的说明: XMLElement
    
    Supposed to be overriden by derived classes to implement element specific reading from an XML file. This implementation satisfies only "simple" elements. 把XML元素转化成值对象
    
    覆盖:
    
    fromXML 在类中 XMLElement
    
    参数:
    
    node - The content retrieved from XML file, that represents tag for this element.
  - toString
```
public String toString()
```
    从类复制的说明: XMLElement
    
    Returns the text representation of element's 'value'. This method only calls toString method of it's value member, if value is null, returns labelName member.
    
    覆盖:
    
    toString 在类中 XMLElement
    
    返回:
    
    The value's string representation.
  - getReadOnlyMessageName
```
public String getReadOnlyMessageName(XMLComplexElement el)
```
    Returns the name of the message defined within property file that explains the reason why element marked as read only can't be deleted.
  - getInUseMessageName
```
public String getInUseMessageName(XMLComplexElement el)
```
    Returns the name of the message defined within property file that explains the reason why element that is in use can't be deleted.
  - clone
```
public Object clone()
```
    从类复制的说明: XMLElement
    
    Used to create exact copy of instance of this class. The newly created instance will have the same name, label name and value as the copied instance. Also it will have the same 'read only' and 'required' properties as the copied one. 提供该对象的clone方法
    
    覆盖:
    
    clone 在类中 XMLElement
    
    返回:
    
    The newly created instance of XMLElement class.
  - setIDPrefix
```
public void setIDPrefix(String idPref)
```
    Sets the prefix for some ID generated by #generateID.
  - getIDPrefix
```
public String getIDPrefix()
```
    Returns the prefix of some ID generated by #generateID.
  - setCurrentID
```
protected void setCurrentID(long ID)
```
    Sets the ID upon further IDs are generated.
  - getCurrentID
```
public long getCurrentID()
```
    Gets the ID upon further IDs are generated.
  - generateID
```
public String generateID()
```
    Generates numerical ID for elements that need it, and converts that ID to string by adding it a prefix that is set using #setIDPrefix method. ID is generated by incrementing the previously generated numerical ID. 返回新生成的UUID
    
    返回:
    
    The string representation of ID.
  - resetID
```
protected void resetID()
```
    Resets an ID generator. Used when opening an existing XML file or when creating a new file.
  - decrementID
```
protected void decrementID()
```
    Decrements an ID. Used when the temporary element is created. This avoids unnecessary incrementation of IDs.
  - updateID
```
protected void updateID(String someID)
```
    Updates an ID. Used when importing an existing XML file. The method updates ID and prepeares it for generation of new ID.
    
    参数:
    
    someID - the ID value upon the update is performed.
  - refreshLabelName
```
public void refreshLabelName()
```
    覆盖:
    
    refreshLabelName 在类中 XMLElement
  - isIdValid
```
public static boolean isIdValid(String id)
```
    Checks if Id is valid NMTOKEN string.
  - getEditableTableFieldOrdinals
```
public int[] getEditableTableFieldOrdinals()
```
  - getEditableDefaultValue
```
public DefaultCellEditor getEditableDefaultValue(int column)
```
  - isJCheckBox
```
public boolean isJCheckBox(int column)
```
  - getValues
```
public Collection getValues()
```
  - getJList
```
public JList getJList()
```
  - setOwner
```
public void setOwner(XMLComplexElement myOwner)
```
  - getNode
```
public DefaultMutableTreeNode getNode()
```
    从类复制的说明: XMLElement
    
    Make tree node for this element and all subelements.
    
    覆盖:
    
    getNode 在类中 XMLElement
    
    返回:
    
    tree node for this element.
  - getXPDLNode
```
public DefaultMutableTreeNode getXPDLNode()
```

类 XMLCollection

字段概要

从类继承的字段 com.ds.bpm.bpd.xml.XMLElement

构造器概要

方法概要

从类继承的方法 com.ds.bpm.bpd.xml.XMLElement

从类继承的方法 java.lang.Object

字段详细资料

IDPrefix

refCollectionElements

controlledPanel

controlPanel

myOwner

构造器详细资料

XMLCollection

XMLCollection

方法详细资料

getOwner

add

remove

get

size

clear

refreshCollection

getCollectionElement

getElementStructure

getInvisibleTableFieldOrdinals

setReadOnly

toCollection

getTableElements

getChoosable

generateNewElement

onElementCreated

onElementInserted

onElementModified

onElementDeleted

onElementRemoved

canInsertElement

canRemoveElement

getControlledPanel

getControlPanel

isEmpty

getPanel

toXML

fromXML

toString

getReadOnlyMessageName

getInUseMessageName

clone

setIDPrefix

getIDPrefix

setCurrentID

getCurrentID

generateID

resetID

decrementID

updateID

refreshLabelName

isIdValid

getEditableTableFieldOrdinals

getEditableDefaultValue

isJCheckBox

getValues

getJList

setOwner

getNode

getXPDLNode