|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Here is the base interface XO Objects have to implement.
Classes implementing XoObject
are Java representations of an XML element.
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a listener of PropertyChangeEvent fired by this .
|
void |
addVetoableChangeListener(java.beans.VetoableChangeListener l)
Adds a VetoableChangeListener to the listener list. |
void |
checkXoValidity()
Checks whether object is valid in regard of original XML Schema. |
java.lang.Object |
clone()
Returns a copy of this object only (not a deep copy). |
boolean |
equalsXoObject(XoObject xo)
Checks whether or not this could be equal to xo . |
java.util.Locale |
getLocale()
Returns the currently selected locale, previously and directly set according to XML attribute xml:lang . |
java.lang.String |
getXmlLocalName()
Returns the XML local name of the element represented by this . |
java.lang.String |
getXmlNameSpace()
Returns the XML NameSpace of the element represented by this . |
byte |
getXmlWhiteSpace()
Returns the currently selected space management directive, previously and directly set according to XML attribute xml:space . |
XoDMInstance |
getXoDMInstance()
Returns the XO Data-Model instance owning this XO Object. |
XoContainer |
getXoParent()
Returns the XO Container parent of this . |
boolean |
isXoPropertyToWrite(java.lang.String pname)
Informs XML writing system of what to do with this property : write or not ? |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a listener of PropertyChangeEvent previously registered
by corresponding add method. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener l)
Removes a VetoableChangeListener from the listener list. |
void |
setIntegrated(boolean integrated)
Informs this that it has just been completely integrated in a DM Instance as child of an XoContainer or completely removed from a DM Instance. |
void |
setLocale(java.util.Locale locale)
This property is directly set according to XML attribute xml:lang . |
void |
setXmlLocalName(java.lang.String localName)
Sets the XML local name used with this .
|
void |
setXmlNameSpace(java.lang.String xmlNameSpace)
Sets the XML local name used with this .
|
void |
setXmlWhiteSpace(byte wsd)
This property is directly set according to XML attribute xml:space . |
void |
setXoDMInstance(XoDMInstance mi)
Sets the XO Data-Model instance owning this XO Object. |
void |
setXoParent(XoContainer parent)
Sets the XO Container parent of t this . |
Method Detail |
public java.lang.String getXmlLocalName()
this
.
public void setXmlLocalName(java.lang.String localName)
this
.
This method is useful only when this can serve as implementation of several elements.
localName
- the XML local namepublic java.lang.String getXmlNameSpace()
this
.
public void setXmlNameSpace(java.lang.String xmlNameSpace)
this
.
This method is useful only when this can serve as implementation of several elements, in multiple name spaces.
xmlNameSpace
- the XML name space.public void setXoDMInstance(XoDMInstance mi)
mi
- the Data-Model instance owner, or null if this object is not in
an XO Data-Model instance.public XoDMInstance getXoDMInstance()
public void setXoParent(XoContainer parent)
this
. Only the root object has no parent.
parent
- XO Container parent of this, or null if this object
is not in a DM instance.public XoContainer getXoParent()
this
. Only the root object has no parent.
this
, or null if this object
is not in a DM instancepublic java.lang.Object clone()
XoParent
and owner DM instance properties.
public boolean equalsXoObject(XoObject xo)
xo
. This method can be used to check
equality from an XML point of vue. Content children are not considered in this checking.
xo
- an XO object to compare to this
public void checkXoValidity() throws XoValidityException
XoException
- when this element is not valid, with the reason why
XoValidityException
public boolean isXoPropertyToWrite(java.lang.String pname)
pname
- the name of a property of this
public java.util.Locale getLocale()
xml:lang
. If no value specified, can return null
.
public void setLocale(java.util.Locale locale) throws java.beans.PropertyVetoException
xml:lang
.
locale
- a Locale object holding xml:lang
value.
java.beans.PropertyVetoException
- if this
is in a DM instance in read-only modepublic byte getXmlWhiteSpace()
xml:space
. By default, must return XoConstants.WS_COLLAPSE
which corresponds to xml:space=DEFAULT
.
XoConstants.WS_PRESERVE
or XoConstants.WS_COLLAPSE
(default).public void setXmlWhiteSpace(byte wsd) throws java.beans.PropertyVetoException
xml:space
.
wsd
- either XoConstants.WS_PRESERVE
or XoConstants.WS_COLLAPSE
(xml:space=DEFAULT).
java.beans.PropertyVetoException
- if this
is in a DM instance in read-only modepublic void setIntegrated(boolean integrated)
XoRoot
objects
integrated
- true if integrated, false if completely removedpublic void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeEvent
fired by this
.
PropertyChange events are fired (if necessary) when properties are changed.
listener
- a PropertyChangeEvent
listenerpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeEvent
previously registered
by corresponding add method.
listener
- a PropertyChangeEvent
listener registeredpublic void addVetoableChangeListener(java.beans.VetoableChangeListener l)
VetoableChangeListener
to the listener list.
l
- The listener to add.public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
VetoableChangeListener
from the listener list.
l
- The listener to remove.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |