/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 * 
 * 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.
 * 
 *************************************************************/


package org.openoffice.xmerge.converter.xml.sxc.pexcel.records;

import java.io.OutputStream;
import java.io.InputStream;
import java.io.IOException;
import java.awt.Point;

import org.openoffice.xmerge.util.Debug;
import org.openoffice.xmerge.util.EndianConverter;
import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
import org.openoffice.xmerge.converter.xml.sxc.SheetSettings;


/**
 * Represents a BIFF Record that describes worksheet window attributes
 */
public class Window2 implements BIFFRecord {

	private final static int FROZEN 	= 0x08;
	private final static int NOSPLIT	= 0x01;

    private byte[] rwTop	= new byte[2];
    private byte   colLeft;
    private byte[] grbit	= new byte[2];
    
	/**
     * Constructor  
	 */
    public Window2() {
		this.rwTop		= EndianConverter.writeShort((short) 0);
		this.colLeft	= 0; 
		this.grbit		= EndianConverter.writeShort((short) 0);
    }
	
   	/**
 	 * Constructs a Window2 Record from an <code>InputStream</code> 
 	 *
 	 * @param	is InputStream containing a Window2 Record 
 	 */
    public Window2(InputStream is) throws IOException {
		read(is);	
    }

    /**
	 * Get the hex code for this particular <code>BIFFRecord</code> 
	 *
	 * @return the hex code for <code>Window2</code>
	 */
    public short getBiffType() {
        return PocketExcelConstants.SHEET_WINDOW_INFO;
    }

	/**
	 * Sets the split type for this pane, the split type is the same for both
	 * x and y so we only test against one.
	 *
	 * @param splitType the split type based on types defined in
	 * <code>sheetSettings</code>
	 */
	public void setSplitType(Point splitType) {
		if(splitType.getX()==SheetSettings.SPLIT) {
			grbit[0] &= ~FROZEN;
			grbit[1] &= ~NOSPLIT;
		} else {
			grbit[0] |= FROZEN;
			grbit[1] |= NOSPLIT;
		}
	}

	/** 
	 * This method tests if this object describes a freeze 
	 *
	 * @return true if freeze otherwise false
	 */
 	public boolean isFrozen() {
		if((grbit[0] & FROZEN) != FROZEN)
			return false;

		if((grbit[1] & NOSPLIT) != NOSPLIT)
			return false;

		return true;
	}

	/** 
	 * This method tests if this object describes a split
	 *
	 * @return true if split otherwise false
	 */
 	public boolean isSplit() {
		if((grbit[0] & FROZEN) == FROZEN)
			return false;

		if((grbit[1] & NOSPLIT) == NOSPLIT)
			return false;

		return true;
	}
	
   	/**
 	 * Reads a Window2 Record from an <code>InputStream</code> 
 	 *
 	 * @param	is InputStream containing a Window2 Record 
 	 */
    public int read(InputStream input) throws IOException {
		
        int numOfBytesRead	= input.read(rwTop);
        colLeft				= (byte) input.read();
		numOfBytesRead++;
        numOfBytesRead		+= input.read(grbit);
        
        Debug.log(Debug.TRACE,"\trwTop : "+ EndianConverter.readShort(rwTop) + 
                            " colLeft : " + colLeft +
                            " grbit : " + EndianConverter.readShort(grbit));
        return numOfBytesRead;        
    }
    
    public void write(OutputStream output) throws IOException {

		output.write(getBiffType());
		output.write(rwTop);
		output.write(colLeft);
		output.write(grbit);

		Debug.log(Debug.TRACE,"Writing Window2 record");
    }
}