Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface XmlElement

All Superinterfaces:

Reference

@Plural("XML elements")
@Code("xmle")
@Name("XML element")
public interface XmlElement
extends Reference

A unit of data in XML format.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countXmlAttributes()
int	countXmlAttributes(String filter)
default int	countXmlElements()
int	countXmlElements(String filter)
String	getId()	The unique identifier of the XML element.
String	getName()	The name of the XML element.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
Reference	getValue()	The value of the XML element.
XmlAttribute	getXmlAttribute(int index)
XmlAttribute	getXmlAttribute(Id id)
default XmlAttribute[]	getXmlAttributes()
XmlAttribute[]	getXmlAttributes(String filter)
XmlElement	getXmlElement(int index)
XmlElement	getXmlElement(Id id)
default XmlElement[]	getXmlElements()
XmlElement[]	getXmlElements(String filter)
void	setValue(Reference value)	The value of the XML element.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getXmlAttributes

@Kind("element")
@Type("XML attribute")
default XmlAttribute[] getXmlAttributes()

Returns:

an array of all XmlAttributes

getXmlAttributes

@Kind("element")
@Type("XML attribute")
XmlAttribute[] getXmlAttributes(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all XmlAttributes

getXmlAttribute

@Kind("element")
@Type("XML attribute")
XmlAttribute getXmlAttribute(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the XmlAttribute at the requested index

getXmlAttribute

@Kind("element")
@Type("XML attribute")
XmlAttribute getXmlAttribute(Id id)

Parameters:

id - id of the item

Returns:

the XmlAttribute with the requested id

countXmlAttributes

@Kind("element")
@Type("XML attribute")
default int countXmlAttributes()

Returns:

number of all XmlAttributes

countXmlAttributes

@Kind("element")
@Type("XML attribute")
int countXmlAttributes(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getXmlElements

@Kind("element")
@Type("XML element")
default XmlElement[] getXmlElements()

Returns:

an array of all XmlElements

getXmlElements

@Kind("element")
@Type("XML element")
XmlElement[] getXmlElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all XmlElements

getXmlElement

@Kind("element")
@Type("XML element")
XmlElement getXmlElement(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the XmlElement at the requested index

getXmlElement

@Kind("element")
@Type("XML element")
XmlElement getXmlElement(Id id)

Parameters:

id - id of the item

Returns:

the XmlElement with the requested id

countXmlElements

@Kind("element")
@Type("XML element")
default int countXmlElements()

Returns:

number of all XmlElements

countXmlElements

@Kind("element")
@Type("XML element")
int countXmlElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique identifier of the XML element.

Returns:

property value

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the XML element.

Returns:

property value

getValue

@Code("valL")
@Kind("property")
@Name("value")
@Type("any")
Reference getValue()

The value of the XML element.

Returns:

property value

setValue

@Code("valL")
@Kind("property")
@Name("value")
@Type("any")
void setValue(Reference value)

The value of the XML element.

Parameters:

value - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties