|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NodeTypeDefinition
The NodeTypeDefinition
interface provides methods for
discovering the static definition of a node type. These are accessible both
before and after the node type is registered. Its subclass
NodeType
adds methods that are relevant only when the node type
is "live"; that is, after it has been registered. Note that the separate
NodeDefinition
interface only plays a significant role in
implementations that support node type registration. In those cases it serves
as the superclass of both NodeType
and
NodeTypeTemplate
. In implementations that do not support node
type registration, only objects implementing the subinterface
NodeType
will be encountered.
Method Summary | |
---|---|
NodeDefinition[] |
getDeclaredChildNodeDefinitions()
Returns an array containing the child node definitions actually declared in this node type. |
PropertyDefinition[] |
getDeclaredPropertyDefinitions()
Returns an array containing the property definitions actually declared in this node type. |
String[] |
getDeclaredSupertypeNames()
Returns the names of the supertypes actually declared in this node type. |
String |
getName()
Returns the name of the node type. |
String |
getPrimaryItemName()
Returns the name of the primary item (one of the child items of the nodes of this node type). |
boolean |
hasOrderableChildNodes()
Returns true if nodes of this type must support orderable
child nodes; returns false otherwise. |
boolean |
isAbstract()
Returns true if this is an abstract node type; returns
false otherwise. |
boolean |
isMixin()
Returns true if this is a mixin type; returns
false if it is primary. |
Method Detail |
---|
String getName()
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
null
.
String
String[] getDeclaredSupertypeNames()
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return an array
containing a single string indicating the node type
nt:base
.
String
sboolean isAbstract()
true
if this is an abstract node type; returns
false
otherwise.
An abstract node type is one that cannot be assigned as the primary or
mixin type of a node but can be used in the definitions of other node
types as a superclass.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
false
.
boolean
boolean isMixin()
true
if this is a mixin type; returns
false
if it is primary.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
false
.
boolean
boolean hasOrderableChildNodes()
true
if nodes of this type must support orderable
child nodes; returns false
otherwise. If a node type returns
true
on a call to this method, then all nodes of that node
type must support the method Node.orderBefore
. If a
node type returns false
on a call to this method, then nodes
of that node type may support Node.orderBefore
. Only
the primary node type of a node controls that node's status in this regard.
This setting on a mixin node type will not have any effect on the node.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
false
.
boolean
String getPrimaryItemName()
null
. This indicator is used by the method
Node.getPrimaryItem()
.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
null
.
String
PropertyDefinition[] getDeclaredPropertyDefinitions()
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
null
.
PropertyDefinition
sNodeDefinition[] getDeclaredChildNodeDefinitions()
NodeTypeDefinition
object is actually a newly-created empty
NodeTypeTemplate
, then this method will return
null
.
NodeDefinition
s
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |