NewXMLComplexElement (onecode-esdstudio 1.0.8 API)

java.lang.Object
- com.ds.bpm.bpd.xml.NewXMLElement
- - com.ds.bpm.bpd.xml.NewXMLComplexElement

所有已实现的接口:

Serializable, Cloneable

直接已知子类:

DefInfo, NewXMLCollectionElement
```
public class NewXMLComplexElement
extends NewXMLElement
```
Represents the complex XML element. For e.g., the following definition within XML schema:
```
  <xsd:element name="DataField">
     <xsd:complexType>
        <xsd:sequence>
           <xsd:element ref="DataType"/>
           <xsd:element ref="InitialValue" minOccurs="0"/>
           <xsd:element ref="Length" minOccurs="0"/>
           <xsd:element ref="Description" minOccurs="0"/>
           <xsd:element ref="ExtendedAttributes" minOccurs="0"/>
        </xsd:sequence>
        <xsd:attribute name="Id" type="xsd:NMTOKEN" use="required"/>
        <xsd:attribute name="Name" type="xsd:string"/>
        <xsd:attribute name="IsArray" default="FALSE">
           <xsd:simpleType>
              <xsd:restriction base="xsd:NMTOKEN">
                 <xsd:enumeration value="TRUE"/>
                 <xsd:enumeration value="FALSE"/>
              </xsd:restriction>
           </xsd:simpleType>
        </xsd:attribute>
     </xsd:complexType>
  </xsd:element>
 
```
will be presented as the object of the class derived from this class, and the name of the class will be DataField. The DataField object will have the other objects which are instances of XMLElement class that will be placed within it's collection complexStructure. These elements, in this particular case, will be the instances of XMLAttribute class (that will be also placed into another collection - attributes) which will represent the 'Id', 'Name' and 'IsArray' XML attribute, the instances of classes InitialValue, Length, Description which are all derived from XMLSimpleElement class and represents corresponding XML simple elements, and the instances of classes DataType and ExtendedAttributes, which are also derived from XMLComplexElement class.
The panels of elements that instance of XMLComplexElement class contains in it's complexStructure collection, will be placed on it's panel, which allows it's editing.
When writting or reading XML document, the complexStructure will be used to write/read all required elements.
The methods for setting or getting the value of each element by it's name, or by it's position within complexStructure collectioin is provided.
NOTE: Although this class is not declared abstract, it is uselles without redefining it's method fillStructure(). The classes derived from this class corresponds to the complex XML element.
另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected List`	`attributes` The list of attributes that complex element contains.
`protected List`	`complexStructure` The list of all elements (attributes, and other elements) that complex element is consisted of.

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

构造器概要

构造器
构造器和说明

NewXMLComplexElement()

构造器
构造器和说明
`NewXMLComplexElement()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Object`	`clone()` Used to create exact copy of instance of this class.
`protected void`	`fillStructure()` The classes that are derived from this class has to give its definition for this method.
`void`	`fromXML(Node node)` Supposed to be overriden by derived classes to implement element specific reading from an XML file.
`XMLElement`	`get(int no)` Gets the element that is placed at specified no. within structure.
`XMLElement`	`get(String name)` Gets the element with specified name from stucture.
`List`	`getChildElements()` Return element child nodes, without attributes.
`int`	`getElementsCount()` Count child elements of this complex element.
`DefaultMutableTreeNode`	`getNode()` DefaultMutableTreeNode with all subnodes of this element.
`NewXMLPanel`	`getPanel()` Returns the panel for editing the element.
`String`	`getPrintDescription(String indent, StyledDocument doc)` Make print description of this element and all subelements and attributes.
`boolean`	`isEmpty()` Indicates if element is empty.
`boolean`	`isValid()` Indicates if element is valid in XML XML sense.
`protected void`	`processAttributes(Node node)`
`protected void`	`processElements(Node node)`
`void`	`refreshLabelName()`
`void`	`set(int no, Object value)` Sets the element that is placed at specified no. within structure to the specified value.
`void`	`set(String name, Object value)` Sets the element with specified name from stucture to the specified value.
`void`	`setReadOnly(boolean ro)` Sets the element and all elements it is made of to be read only or not.
`Collection`	`toComplexType()` Returns the collection of elements this element is made of.
`Collection`	`toComplexTypeValues()` Returns the collection of strings that represents elements that this element is made of.
`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.

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

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

- 字段详细资料
  - complexStructure
```
protected List complexStructure
```
    The list of all elements (attributes, and other elements) that complex element is consisted of.
  - attributes
```
protected List attributes
```
    The list of attributes that complex element contains.
- 构造器详细资料
  - NewXMLComplexElement
```
public NewXMLComplexElement()
```
- 方法详细资料
  - toComplexType
```
public Collection toComplexType()
```
    Returns the collection of elements this element is made of.
  - toComplexTypeValues
```
public Collection toComplexTypeValues()
```
    Returns the collection of strings that represents elements that this element is made of.
  - setReadOnly
```
public void setReadOnly(boolean ro)
```
    Sets the element and all elements it is made of to be read only or not.
    
    覆盖:
    
    setReadOnly 在类中 NewXMLElement
    
    参数:
    
    ro - true if element will be 'read only', false otherwise.
  - isEmpty
```
public boolean isEmpty()
```
    从类复制的说明: NewXMLElement
    
    Indicates if element is empty. Some derived classes (especially class that represents complex element) need to redefine this method.
    
    覆盖:
    
    isEmpty 在类中 NewXMLElement
    
    返回:
    
    true if user haven't defined the element value within dialog, false otherwise.
  - isValid
```
public boolean isValid()
```
    从类复制的说明: NewXMLElement
    
    Indicates if element is valid in XML XML sense. This implementation claims that element is always valid. The derived classes has to implement it's own definition of validity.
    
    覆盖:
    
    isValid 在类中 NewXMLElement
    
    返回:
    
    true if element is valid, false otherwise.
  - toXML
```
public void toXML(Node parent)
           throws DOMException
```
    从类复制的说明: NewXMLElement
    
    Supposed to be overriden by derived classes to implement element specific writting to an XML file.
    
    覆盖:
    
    toXML 在类中 NewXMLElement
    
    参数:
    
    parent - parent node
    
    抛出:
    
    DOMException
  - fromXML
```
public void fromXML(Node node)
```
    从类复制的说明: NewXMLElement
    
    Supposed to be overriden by derived classes to implement element specific reading from an XML file. This implementation satisfies only "simple" elements.
    
    覆盖:
    
    fromXML 在类中 NewXMLElement
    
    参数:
    
    node - root node
  - processAttributes
```
protected void processAttributes(Node node)
```
  - processElements
```
protected void processElements(Node node)
```
  - getPanel
```
public NewXMLPanel getPanel()
```
    从类复制的说明: NewXMLElement
    
    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.
    
    覆盖:
    
    getPanel 在类中 NewXMLElement
    
    返回:
    
    A panel to put into dialog for editing element.
  - get
```
public XMLElement get(int no)
```
    Gets the element that is placed at specified no. within structure.
  - set
```
public void set(int no,
                Object value)
```
    Sets the element that is placed at specified no. within structure to the specified value.
  - get
```
public XMLElement get(String name)
```
    Gets the element with specified name from stucture.
  - set
```
public void set(String name,
                Object value)
```
    Sets the element with specified name from stucture to the specified value.
  - toString
```
public String toString()
```
    从类复制的说明: NewXMLElement
    
    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 在类中 NewXMLElement
    
    返回:
    
    The value's string representation.
  - fillStructure
```
protected void fillStructure()
```
    The classes that are derived from this class has to give its definition for this method. It is used to insert all members of those classes that are derived from XMLElement class (or classes that are derived from that class) into one list, and the members that are derived from XMLAttribute class also to insert into other list. Many methods of this class uses those lists: toXML method uses them to properly write an element tag to the XML file, fromXML method uses them to properly read an element tag from the XML file, getPanel method uses them to properly display members of this class, get and set uses them to properly retrieve/set the elements from list, ... and so on
    NOTE: The order of inserted elements is relevant for XML to be valid (members of classes derived from this class must be inserted into first mentioned list in the same order that they are within a corresponding tag for those classes within WfMC XML).
  - clone
```
public Object clone()
```
    从类复制的说明: NewXMLElement
    
    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 在类中 NewXMLElement
    
    返回:
    
    The newly created instance of XMLElement class.
  - refreshLabelName
```
public void refreshLabelName()
```
    覆盖:
    
    refreshLabelName 在类中 NewXMLElement
  - getNode
```
public DefaultMutableTreeNode getNode()
```
    DefaultMutableTreeNode with all subnodes of this element.
    
    覆盖:
    
    getNode 在类中 NewXMLElement
    
    返回:
    
    return node with subelements.
  - getElementsCount
```
public int getElementsCount()
```
    Count child elements of this complex element.
    
    返回:
    
    count of subelements.
  - getChildElements
```
public List getChildElements()
```
    Return element child nodes, without attributes.
    
    返回:
    
    list with subelements.
  - getPrintDescription
```
public String getPrintDescription(String indent,
                                  StyledDocument doc)
```
    Make print description of this element and all subelements and attributes.
    
    覆盖:
    
    getPrintDescription 在类中 NewXMLElement
    
    返回:
    
    print description of element

类 NewXMLComplexElement

字段概要

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

构造器概要

方法概要

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

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

字段详细资料

complexStructure

attributes

构造器详细资料

NewXMLComplexElement

方法详细资料

toComplexType

toComplexTypeValues

setReadOnly

isEmpty

isValid

toXML

fromXML

processAttributes

processElements

getPanel

get

set

get

set

toString

fillStructure

clone

refreshLabelName

getNode

getElementsCount

getChildElements

getPrintDescription