XMLElement (onecode-esdstudio 1.0.8 API)

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

所有已实现的接口:

Serializable, Cloneable

直接已知子类:

XMLChoice, XMLCollection, XMLComplexElement, XMLExpressionElement, XMLSelectOption, XMLSimpleElement
```
public class XMLElement
extends Object
implements Serializable, Cloneable
```
XMLElement class instance represents program equivalence to the element defined in some XML XML. It contains main characteristics common for all XML elements, and is intended to be uses as the base class for classes that will represent concrete XML element such as "simple" element, "complex" element, "collection" of elements, "choice" of elements, "attribute" ...
When classes that extends this class are created, they can call this class constructor without arguments, in which case the member of this class that corresponds to the XML element name is filled with the name of extended class, or with the argument that represents the name of element, where such name directly sets the previously mentioned member (This is the case when creating 'attribute' or 'choice' XML elements). The label to be written in a dialog for editing value of element, is set to the language specific value, which has to be defined in the property file under the key: "ElementNameKey".
This class contains method #getPanel, which should be overriden by classes that extends this class, and which is used to show the panel with the field that represent a value of XML element (In the case of complex elements, the panel will show fields of all elements that complex element is made of). This panel is shown in a dialog (see XMLElementDialog) that allows user to edit this field, and when user presses OK, the new value is put in the value member of this class.
When program decides to write an XML file according to it's XMLElement derived class members, it calls #toXML method of those classes, which is defined by this class, but has no implementation. This method has to write the proper element opening and closing tag (defined by element name), and the previously defined value of element to put inside tags.
When there is a need of reading an XML file, the values that corresponds to particular element (determined by element name and it's position within other elements) are put into this element value member by calling #fromXML method, and passing it a tag to process.
This class also defines methods that are performing a check for validity, emptiness or mandatory status of the element, and are also supposed to be redefined by classes that extends it.

NOTE: Although this class is not declared abstract, it is uselles without redefining it's methods. XML元素的基类

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected AttributeSet`	`atts`
`protected boolean`	`isCollapsed`
`protected boolean`	`isReadOnly` Used in dialogs to forbid editing of an element value.
`protected boolean`	`isRequired` Indicates if an element is required - corresponds to the same XML element definition.
`protected boolean`	`isVisible`
`protected String`	`labelName` Language specific name of XML element that is shown in editing dialog.
`protected String`	`name` Equivalent for XML element name.
`protected String`	`NEWLINE`
`protected String`	`OFFSET`
`protected Object`	`value` Supposed to contain the value for XML element.

构造器概要

构造器
构造器和说明
`XMLElement()` Creates a new instance of element: sets the `name` member to the name of inner class that extends this element, and the `labelName` member to the value read from property file under the key of previously set `name` member.
`XMLElement(String name)` Creates a new instance of element: sets the `name` member to the specified one, and the `labelName` member to the value read from property file under the key of previously set `name` member.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Object`	`clone()` Used to create exact copy of instance of this class.
`void`	`fromXML(Node node)` Supposed to be overriden by derived classes to implement element specific reading from an XML file.
`void`	`fromXML(String name, Node node)` Supposed to be used (and overriden) by class that represent XML choice of complex elements.
`DefaultMutableTreeNode`	`getNode()` Make tree node for this element and all subelements.
`XMLPanel`	`getPanel()` Returns the panel for editing the element.
`String`	`getPrintDescription(String indent, StyledDocument doc)` Description of this element and all subelements.
`String`	`getPrintDescription(StyledDocument doc)` This method will call getPrintDescription(String indent) with parameter OFFSET.
`boolean`	`isCollapsed()`
`boolean`	`isEmpty()` Indicates if element is empty.
`boolean`	`isReadOnly()` Returns the 'read only' status of element.
`boolean`	`isRequired()` Returns the 'required' property of the element.
`boolean`	`isValid()` Indicates if element is valid in XML XML sense.
`boolean`	`isValidEnter(XMLPanel p)` Indicates if dialog data enter for element is valid.
`boolean`	`isVisible()`
`void`	`refreshLabelName()`
`void`	`setCollapsed(boolean isCollapsed)`
`void`	`setLabelName(String lName)`
`void`	`setReadOnly(boolean ro)` Sets the 'read only' property of element to the specified one.
`void`	`setRequired(boolean r)` Sets the 'required' property of the element.
`void`	`setValue(Object v)` Sets the element value (in the sense of XML element).
`void`	`setVisible(boolean isVisible)`
`String`	`toLabel()` Returns the text for element 'name' presentation within a dialog for editing element.
`String`	`toName()` Returns the name of element.
`String`	`toString()` Returns the text representation of element's 'value'.
`Object`	`toValue()` Gets the element value.
`void`	`toXML(Node parent)` Supposed to be overriden by derived classes to implement element specific writting to an XML file.

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

- 字段详细资料
  - name
```
protected String name
```
    Equivalent for XML element name. Used when writting instance of this class to XML file. XML元素的TagName
  - labelName
```
protected String labelName
```
    Language specific name of XML element that is shown in editing dialog. 显示在Dialog上的Name
  - value
```
protected Object value
```
    Supposed to contain the value for XML element. This is true for simple elements and attributes, more complex elements uses it as they need. XML元素的值
  - isRequired
```
protected boolean isRequired
```
    Indicates if an element is required - corresponds to the same XML element definition. 标识该元素是否必须存在
  - isReadOnly
```
protected boolean isReadOnly
```
    Used in dialogs to forbid editing of an element value. 标识该元素在Dialog上是否可编辑
  - isVisible
```
protected boolean isVisible
```
  - isCollapsed
```
protected boolean isCollapsed
```
  - OFFSET
```
protected String OFFSET
```
  - NEWLINE
```
protected String NEWLINE
```
  - atts
```
protected AttributeSet atts
```
- 构造器详细资料
  - XMLElement
```
public XMLElement()
```
    Creates a new instance of element: sets the name member to the name of inner class that extends this element, and the labelName member to the value read from property file under the key of previously set name member.
  - XMLElement
```
public XMLElement(String name)
```
    Creates a new instance of element: sets the name member to the specified one, and the labelName member to the value read from property file under the key of previously set name member.
    
    参数:
    
    name - The name of XML element that this class represents.
- 方法详细资料
  - setReadOnly
```
public void setReadOnly(boolean ro)
```
    Sets the 'read only' property of element to the specified one. This enables/disables editing of the element within dialog. Some derived classes (especially class that represents complex element) need to redefine this method.
    
    参数:
    
    ro - true if element will be 'read only', false otherwise.
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns the 'read only' status of element. This indicates if the editing of element within dialog is enabled or disabled.
    
    返回:
    
    true if element is 'read only', false otherwise.
  - setRequired
```
public void setRequired(boolean r)
```
    Sets the 'required' property of the element. If element is 'required', the dialog for editing it's value can't be closed until the value is defined.
    
    参数:
    
    r - true if element will be 'required', false otherwise.
  - isRequired
```
public boolean isRequired()
```
    Returns the 'required' property of the element. If element is 'required', the dialog for editing it's value can't be closed until the value is defined.
    
    返回:
    
    true if element is 'required', false otherwise.
  - isEmpty
```
public boolean isEmpty()
```
    Indicates if element is empty. Some derived classes (especially class that represents complex element) need to redefine this method.
    
    返回:
    
    true if user haven't defined the element value within dialog, false otherwise.
  - isValid
```
public boolean isValid()
```
    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.
    
    返回:
    
    true if element is valid, false otherwise.
  - isValidEnter
```
public boolean isValidEnter(XMLPanel p)
```
    Indicates if dialog data enter for element is valid. This implementation claims that element is always valid. The derived classes has to implement it's own definition of validity.
    
    返回:
    
    true if dialog data for the element are valid, false otherwise.
  - toXML
```
public void toXML(Node parent)
           throws DOMException
```
    Supposed to be overriden by derived classes to implement element specific writting to an XML file. 把值对象格式化成XML元素
    
    参数:
    
    parent - indicates how much tabulators to put before element tag.
    
    抛出:
    
    DOMException
  - fromXML
```
public void fromXML(Node node)
```
    Supposed to be overriden by derived classes to implement element specific reading from an XML file. This implementation satisfies only "simple" elements. 把XML元素转化成值对象
    
    参数:
    
    node - The content retrieved from XML file, that represents tag for this element.
  - fromXML
```
public void fromXML(String name,
                    Node node)
```
    Supposed to be used (and overriden) by class that represent XML choice of complex elements.
    
    参数:
    
    name - The element name.
    
    node - The content retrieved from XML file, that represents tag for this element.
  - getPanel
```
public XMLPanel getPanel()
```
    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
    
    返回:
    
    A panel to put into dialog for editing element.
  - setLabelName
```
public void setLabelName(String lName)
```
  - setValue
```
public void setValue(Object v)
```
    Sets the element value (in the sense of XML element).
    
    参数:
    
    v - The value to set.
  - toValue
```
public Object toValue()
```
    Gets the element value. The value represents an XML tag content for this element.
    
    返回:
    
    The value of this element.
  - toLabel
```
public String toLabel()
```
    Returns the text for element 'name' presentation within a dialog for editing element. This text is language specific and is set reading a property file.
    
    返回:
    
    The language specific presentation of element 'name'.
  - toName
```
public String toName()
```
    Returns the name of element.
    
    返回:
    
    The 'name' attribute of element.
  - toString
```
public String toString()
```
    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 在类中 Object
    
    返回:
    
    The value's string representation.
  - clone
```
public Object clone()
```
    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 在类中 Object
    
    返回:
    
    The newly created instance of XMLElement class.
  - refreshLabelName
```
public void refreshLabelName()
```
  - getNode
```
public DefaultMutableTreeNode getNode()
```
    Make tree node for this element and all subelements.
    
    返回:
    
    tree node for this element.
  - getPrintDescription
```
public String getPrintDescription(StyledDocument doc)
```
    This method will call getPrintDescription(String indent) with parameter OFFSET. This method is called on root node from which description will be maked.
    
    返回:
    
    Description of this element and all subelements.
  - getPrintDescription
```
public String getPrintDescription(String indent,
                                  StyledDocument doc)
```
    Description of this element and all subelements.
    
    返回:
    
    return print description of element.
  - setVisible
```
public void setVisible(boolean isVisible)
```
  - isVisible
```
public boolean isVisible()
```
  - setCollapsed
```
public void setCollapsed(boolean isCollapsed)
```
  - isCollapsed
```
public boolean isCollapsed()
```

类 XMLElement

字段概要

构造器概要

方法概要

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

字段详细资料

name

labelName

value

isRequired

isReadOnly

isVisible

isCollapsed

OFFSET

NEWLINE

atts

构造器详细资料

XMLElement

XMLElement

方法详细资料

setReadOnly

isReadOnly

setRequired

isRequired

isEmpty

isValid

isValidEnter

toXML

fromXML

fromXML

getPanel

setLabelName

setValue

toValue

toLabel

toName

toString

clone

refreshLabelName

getNode

getPrintDescription

getPrintDescription

setVisible

isVisible

setCollapsed

isCollapsed