Page de couverture | Retour à la conformité | Vers les annexes

WebCGM 2.0 : La liaison ECMAScript

8. La liaison ECMAScript

Cette section est normative.

Objet prototype WebCGMException
    La classe WebCGMException a les constantes suivantes :
        WebCGMException.INDEX_SIZE_ERR
            Cette constante est de type Number et sa valeur est 1.
        WebCGMException.WEBCGMSTRING_SIZE_ERR
            Cette constante est de type Number et sa valeur est 2.
        WebCGMException.INVALID_CHARACTER_ERR
            Cette constante est de type Number et sa valeur est 3.
        WebCGMException.NO_DATA_ALLOWED_ERR
            Cette constante est de type Number et sa valeur est 4.
        WebCGMException.NO_MODIFICATION_ALLOWED_ERR
            Cette constante est de type Number et sa valeur est 5.
        WebCGMException.NOT_SUPPORTED_ERR
            Cette constante est de type Number et sa valeur est 6.
        WebCGMException.INVALID_ACCESS_ERR
            Cette constante est de type Number et sa valeur est 7.
        WebCGMException.FILE_NOT_FOUND_ERR
            Cette constante est de type Number et sa valeur est 8.
        WebCGMException.FILE_INVALID_ERR
            Cette constante est de type Number et sa valeur est 9.

Objet WebCGMException
    L'objet WebCGMException a les propriétés suivantes :
        code
            Cette propriété est de type Number.

Objet GetWebCGMDocument
    L'objet GetWebCGMDocument a les méthodes suivantes :
        getWebCGMDocument()
            Cette méthode retourne un objet WebCGMMetafile.
    getAppName()
            Cette méthode retourne une valeur de type String
    getAppVersion()
            Cette méthode retourne une valeur de type String

Objet WebCGMMetafile
    L'objet WebCGMMetafile a les propriétés suivantes :
        metafileDescription
            Cette propriété en lecture seule est de type String.
        firstPicture
            Cette propriété en lecture seule est un objet WebCGMPicture.
        metafileID
            Cette propriété en lecture seule est de type String.
        metafileVersion
            Cette propriété en lecture seule est de type Number.
        src
            Cette propriété est de type String.

    L'objet WebCGMMetafile a les méthodes suivantes :
        addEventListener(type,listener);
            Le paramètre type est de type String.
            Le paramètre listener est un objet WebCGMEventListener.
        removeEventListener(type,listener);
            Le paramètre type est de type String.
            Le paramètre listener est un objet WebCGMEventListener.

Objet prototype WebCGMNode
    La classe WebCGMNode a les constantes suivantes :
        WebCGMNode.PICTURE_NODE
            Cette constante est de type Number et sa valeur est 1.
        WebCGMNode.APP_STRUCTURE_NODE
            Cette constante est de type Number et sa valeur est 2.
        WebCGMNode.XML_METADATA_NODE
            Cette constante est de type Number et sa valeur est 3.
        WebCGMNode.TEXT_NODE
            Cette constante est de type Number et sa valeur est 4.
        WebCGMNode.ATTR_NODE
            Cette constante est de type Number et sa valeur est 5.

Objet WebCGMNode
    L'objet WebCGMNode a les propriétés suivantes :
        nodeName
            Cette propriété en lecture seule est de type String.
        nodeValue
            Cette propriété en lecture seule est de type String,
            peut soulever une exception WebCGMException à la récupération.
        nodeType
            Cette propriété en lecture seule est de type Number.
        parentNode
            Cette propriété en lecture seule est un objet WebCGMNode.
        childNodes
            Cette propriété en lecture seule est un objet WebCGMNodeList.
        firstChild
            Cette propriété en lecture seule est un objet WebCGMNode.
        lastChild
            Cette propriété en lecture seule est un objet WebCGMNode.
        previousSibling
            Cette propriété en lecture seule est un objet WebCGMNode.
        nextSibling
            Cette propriété en lecture seule est un objet WebCGMNode.
        attributes
            Cette propriété en lecture seule est un objet WebCGMNodeList.
        ownerPicture
            Cette propriété en lecture seule est un objet WebCGMPicture.
        namespaceIRI
            Cette propriété en lecture seule est de type String.
        prefix
            Cette propriété en lecture seule est de type String.
        localName
            Cette propriété en lecture seule est de type String.

    L'objet WebCGMNode a les méthodes suivantes :
        hasChildNodes()
            Cette méthode retourne une valeur de type Boolean.
        hasAttributes()
            Cette méthode retourne une valeur de type Boolean.
        getAttributeNS(namespaceIRI, localName)
            Cette méthode retourne une valeur de type String
            Le paramètre namespaceIRI est de type String.
            Le paramètre localName est de type String.
        setAttributeNS(namespaceIRI, qualifiedName, value)
            Cette méthode ne retourne aucune valeur.
            Le paramètre namespaceIRI est de type String.
            Le paramètre qualifiedName est de type String.
            Le paramètre value est de type String.
        getElementsByTagNameNS(namespaceIRI, localName)
            Cette méthode retourne un objet WebCGMNodeList.
        Le paramètre namespaceIRI est de type String.
            Le paramètre localName est de type String.

Objet WebCGMPicture
    L'objet WebCGMPicture a toutes les propriétés et méthodes de l'objet WebCGMNode
    ainsi que les propriétés et méthodes définies ci-dessous.

    L'objet WebCGMPicture a les propriétés suivantes :
        width
            Cette propriété en lecture seule est de type Number.
        height
            Cette propriété en lecture seule est de type Number.
        pictid
            Cette propriété en lecture seule est de type String.

    L'objet WebCGMPicture a les méthodes suivantes :
        applyCompanionFile(fileIRI)
            Cette méthode retourne une valeur de type Boolean.
            Le paramètre fileIRI est de type String.
        getAppStructureById(apsId)
            Cette méthode retourne un objet WebCGMAppStructure.
            Le paramètre apsId est de type String.
        getAppStructuresByName(apsName)
            Cette méthode retourne un objet WebCGMNodeList.
            Le paramètre apsName est de type String.
        highlight(nodes,type)
            Cette méthode ne retourne aucune valeur.
            Le paramètre nodes est un objet WebCGMNodeList.
            Le paramètre type est de type WebCGMString.
        clearHighlight()
            Cette méthode ne retourne aucune valeur.
            Cette méthode n'a pas de paramètre.
        setPictureVisibility(visibility)
            Cette méthode ne retourne aucune valeur.
            Le paramètre visibility est de type String.
        setStyleProperty(style,value)
            Cette méthode ne retourne aucune valeur.
            Le paramètre style est de type String.
            Le paramètre value est de type String.
        reloadPicture()
            Cette méthode ne retourne aucune valeur.

Objet WebCGMAppStructure
    L'objet WebCGMAppStructure a toutes les propriétés et méthodes de l'objet WebCGMNode
    ainsi que les propriétés et méthodes définies ci-dessous.

    L'objet WebCGMAppStructure a les propriétés suivantes : 
        apsId
            Cette propriété en lecture seule est de type String.
        nameCount
            Cette propriété en lecture seule est de type Number.
        linkuriCount
            Cette propriété en lecture seule est de type Number.

    L'objet WebCGMAppStructure a les méthodes suivantes :
        getAppStructureAttr(name)
            Cette méthode retourne une valeur de type String
            Le paramètre name est de type String.
        setAppStructureAttr(name,value)
            Cette méthode ne retourne aucune valeur.
            Le paramètre name est de type String.
            Le paramètre value est de type String.
        removeAppStructureAttr(name)
            Cette méthode ne retourne aucune valeur.
            Le paramètre name est de type String.
        setStyleProperty(style,value)
            Cette méthode ne retourne aucune valeur.
            Le paramètre style est de type String.
            Le paramètre value est de type String.
        toNodeList()
            Cette méthode n'a pas de paramètre.
            Cette méthode retourne un objet WebCGMNodeList.
   
Objet WebCGMNodeList
    L'objet WebCGMNodeList a les propriétés suivantes : 
        count
            Cette propriété en lecture seule est de type Number.

    L'objet WebCGMNodeList a les méthodes suivantes :
        item(index)
            Cette méthode retourne un objet WebCGMNode.
            Le paramètre index est de type Number.
        removeItem(index) // devrait-elle soulever une exception ?
            Cette méthode retourne un objet WebCGMNode.
            Le paramètre index est de type Number.
        appendItem(newItem) // devrait-elle soulever une exception ?
            Cette méthode retourne un objet WebCGMNode.
            Le paramètre newItem est un objet WebCGMNode.


Objet WebCGMAttr
    L'objet WebCGMAttr a toutes les propriétés et méthodes de l'objet WebCGMNode
    ainsi que les propriétés et méthodes définies ci-dessous.

    L'objet WebCGMAttr a les propriétés suivantes : 
        name
            Cette propriété en lecture seule est de type String.
        value
            Cette propriété est de type String.
        ownerNode
            Cette propriété en lecture seule est un objet WebCGMNode.

Objet WebCGMEventListener
    C'est une référence de fonction ECMAScript. Cette méthode ne retourne aucune valeur. 
    Le paramètre est un objet WebCGMEvent.

Objet WebCGMEvent
    L'objet WebCGMEvent a les propriétés suivantes :
        type
            Cette propriété en lecture seule est de type String.
        target
            Cette propriété en lecture seule est un objet WebCGMNode.
        button
            Cette propriété en lecture seule est de type Number.
        numPressed
            Cette propriété en lecture seule est de type Number.
        clientX
            Cette propriété en lecture seule est de type Number.
        clientY
            Cette propriété en lecture seule est de type Number.
        ctrlKey
            Cette propriété en lecture seule est de type Boolean.
        shiftKey
            Cette propriété en lecture seule est de type Boolean.
        altKey
            Cette propriété en lecture seule est de type Boolean.
        metaKey
            Cette propriété en lecture seule est de type Boolean.

    L'objet WebCGMEvent a les méthodes suivantes :
        preventDefault()
            Cette méthode ne retourne aucune valeur.

Retour au début du chapitre