/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
 *
 * Use is subject to license terms.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0. You can also
 * obtain a copy of the License at http://odftoolkit.org/docs/license.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ************************************************************************/

/*
 * This file is automatically generated.
 * Don't edit manually.
 */    

package org.odftoolkit.odfdom.dom.element.style;

import org.odftoolkit.odfdom.dom.OdfName;
import org.odftoolkit.odfdom.dom.OdfNamespace;
import org.odftoolkit.odfdom.doc.OdfFileDom;
import org.odftoolkit.odfdom.dom.style.OdfStyleFamily;
import org.odftoolkit.odfdom.dom.element.OdfStylableElement;
import org.odftoolkit.odfdom.dom.type.OdfPositiveInteger;
import org.odftoolkit.odfdom.dom.type.OdfLength;
import org.odftoolkit.odfdom.dom.type.OdfStyleNameRef;

;

/**
 * DOM implementation of OpenDocument element  {@odfLink style:drop-cap}.
 *
 */
public abstract class OdfDropCapElement extends OdfStylableElement
{        
    public static final OdfName ELEMENT_NAME = OdfName.get( OdfNamespace.STYLE, "drop-cap" );

    /**
     * Create the instance of OdfDropCapElement 
     *
     *@param  aOwnerDoc     The type is OdfFileDom
     */
    public OdfDropCapElement( OdfFileDom aOwnerDoc )
    {
        super( aOwnerDoc, ELEMENT_NAME, OdfStyleFamily.Text, OdfName.get( OdfNamespace.TEXT, "style-name" ) );
    }

    /**
     * Get the element name 
     *
     *@return  return   the name of element {@odfLink style:drop-cap}.
     */
    public OdfName getOdfName()
    {
        return ELEMENT_NAME;
    }


    /**
     * Get value of attribute {@attributeName style:length}.
     *
     *@return return the attribute which type is OdfPositiveInteger
     */
    public OdfPositiveInteger getStyleLength()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.STYLE, "length" ) );
        return OdfPositiveInteger.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName style:length}.
     *
     *@param  styleLength    the attribute's type is OdfPositiveInteger
     */ 
     public void setStyleLength( OdfPositiveInteger styleLength )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.STYLE, "length" ), styleLength.toString() );
    }

    /**
     * Get value of attribute {@attributeName style:lines}.
     *
     *@return return the attribute which type is OdfPositiveInteger
     */
    public OdfPositiveInteger getLines()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.STYLE, "lines" ) );
        if( stringVal.length()==0 )
        {
            stringVal = "1";
        }

        return OdfPositiveInteger.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName style:lines}.
     *
     *@param  lines    the attribute's type is OdfPositiveInteger
     */ 
     public void setLines( OdfPositiveInteger lines )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.STYLE, "lines" ), lines.toString() );
    }

    /**
     * Get value of attribute {@attributeName style:distance}.
     *
     *@return return the attribute which type is OdfLength
     */
    public OdfLength getDistance()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.STYLE, "distance" ) );
        if( stringVal.length()==0 )
        {
            stringVal = "0cm";
        }

        return OdfLength.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName style:distance}.
     *
     *@param  distance    the attribute's type is OdfLength
     */ 
     public void setDistance( OdfLength distance )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.STYLE, "distance" ), distance.toString() );
    }

    /**
     * Get value of attribute {@attributeName style:style-name}.
     *
     *@return return the attribute which type is String
     */
    public String getStyleName()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.STYLE, "style-name" ) );
        return OdfStyleNameRef.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName style:style-name}.
     *
     *@param  styleName    the attribute's type is OdfStyleNameRef
     */ 
     public void setStyleName( OdfStyleNameRef styleName )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.STYLE, "style-name" ), styleName.toString() );
    }

}
