001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.xml.xam.dom;
043:
044: import org.netbeans.modules.xml.xam.*;
045: import org.w3c.dom.Element;
046: import org.w3c.dom.Node;
047:
048: /**
049: * A component in model.
050: *
051: */
052: public interface DocumentComponent<C extends DocumentComponent> extends
053: Component<C> {
054: public static final String TEXT_CONTENT_PROPERTY = "textContent";
055:
056: /**
057: * Returns the DOM element corresponding to this component.
058: */
059: Element getPeer();
060:
061: /**
062: * @return string value of the given attribute.
063: */
064: String getAttribute(Attribute attribute);
065:
066: /**
067: * Sets the attribute value.
068: * @param eventPropertyName name property change event to fire.
069: * @param attribute the attribute to set value for.
070: * @param value for the attribute.
071: */
072: void setAttribute(String eventPropertyName, Attribute attribute,
073: Object value);
074:
075: /**
076: * Returns true if the component is part of the document model.
077: */
078: boolean isInDocumentModel();
079:
080: /**
081: * Returns the position of this component in the schema document,
082: * expressed as an offset from the start of the document.
083: * @return the position of this component in the document
084: */
085: int findPosition();
086:
087: /**
088: * Returns true if the node referenced by this component is n.
089: */
090: boolean referencesSameNode(Node n);
091:
092: /**
093: * Returns child component backed by given element node.
094: */
095: public C findChildComponent(Element e);
096:
097: /**
098: * Returns position of the attribute by the given name, or -1 if not found.
099: */
100: public int findAttributePosition(String attributeName);
101: }
|