dvrecord.java

介绍java核心技术的pio编程方法以及基本概念

/* ====================================================================
   Copyright 2002-2004   Apache Software Foundation

   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

   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.apache.poi.hssf.record;

import java.io.IOException;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Stack;

import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.util.HSSFCellRangeAddress;
import org.apache.poi.util.BitField;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;

/**
 * Title:        DV Record<P>
 * Description:  This record stores data validation settings and a list of cell ranges
 *               which contain these settings. The data validation settings of a sheet
 *               are stored in a sequential list of DV records. This list is followed by
 *               DVAL record(s)
 * @author Dragos Buleandra ([e-mail])
 * @version 2.0-pre
 */
public class DVRecord extends Record
{
    public final static short sid = 0x01BE;

    /**
     * Option flags
     */
    private int                field_option_flags;

    /**
     * Title of the prompt box
     */
    private String             field_title_prompt;

    /**
     * Title of the error box
     */
    private String             field_title_error;

    /**
     * Text of the prompt box
     */
    private String             field_text_prompt;

    /**
     * Text of the error box
     */
    private String             field_text_error;

    /**
     * Size of the formula data for first condition
     */
    private short             field_size_first_formula;

    /**
     * Not used
     */
    private short             field_not_used_1 = 0x3FE0;

    /**
     * Formula data for first condition (RPN token array without size field)
     */
    private Stack             field_rpn_token_1 ;

    /**
     * Size of the formula data for second condition
     */
    private short             field_size_sec_formula;

    /**
     * Not used
     */
    private short             field_not_used_2 = 0x0000;

    /**
     * Formula data for second condition (RPN token array without size field)
     */
    private Stack             field_rpn_token_2 ;

    /**
     * Cell range address list with all affected ranges
     */
    private HSSFCellRangeAddress         field_regions;

    public static final Integer STRING_PROMPT_TITLE = new Integer(0);
    public static final Integer STRING_ERROR_TITLE  = new Integer(1);
    public static final Integer STRING_PROMPT_TEXT  = new Integer(2);
    public static final Integer STRING_ERROR_TEXT   = new Integer(3);
    private Hashtable _hash_strings ;

    /**
     * Option flags field
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    private BitField          opt_data_type                    = new BitField(0x0000000F);
    private BitField          opt_error_style                  = new BitField(0x00000070);
    private BitField          opt_string_list_formula          = new BitField(0x00000080);
    private BitField          opt_empty_cell_allowed           = new BitField(0x00000100);
    private BitField          opt_surppres_dropdown_arrow      = new BitField(0x00000200);
    private BitField          opt_show_prompt_on_cell_selected = new BitField(0x00040000);
    private BitField          opt_show_error_on_invalid_value  = new BitField(0x00080000);
    private BitField          opt_condition_operator           = new BitField(0x00F00000);

    public DVRecord()
    {
    }

    /**
     * Constructs a DV record and sets its fields appropriately.
     *
     * @param in the RecordInputstream to read the record from
     */

    public DVRecord(RecordInputStream in)
    {
        super(in);
    }

    protected void validateSid(short id)
    {
        if (id != sid)
        {
            throw new RecordFormatException("NOT a valid DV RECORD");
        }
    }

    protected void fillFields(RecordInputStream in)
    {
       field_rpn_token_1 = new Stack();
       field_rpn_token_2 = new Stack();
        
       this.field_option_flags = in.readInt();
       this._hash_strings = new Hashtable(4);
       
       StringHandler strHandler_prompt_title = new StringHandler( in );
       this.field_title_prompt = strHandler_prompt_title.getStringData();
       this._hash_strings.put(DVRecord.STRING_PROMPT_TITLE, strHandler_prompt_title);

       StringHandler strHandler_error_title = new StringHandler( in );
       this.field_title_error = strHandler_error_title.getStringData();
       this._hash_strings.put(DVRecord.STRING_ERROR_TITLE, strHandler_error_title);

       StringHandler strHandler_prompt_text = new StringHandler( in );
       this.field_text_prompt = strHandler_prompt_text.getStringData();
       this._hash_strings.put(DVRecord.STRING_PROMPT_TEXT, strHandler_prompt_text);

       StringHandler strHandler_error_text = new StringHandler( in );
       this.field_text_error = strHandler_error_text.getStringData();
       this._hash_strings.put(DVRecord.STRING_ERROR_TEXT, strHandler_error_text);

       this.field_size_first_formula = in.readShort(); 
       this.field_not_used_1 = in.readShort();

       //read first formula data condition
       // Not sure if this was needed or not...
//       try {
//    	   in.skip(this.field_size_first_formula);
//       } catch(IOException e) { throw new IllegalStateException(e); } 

       int token_pos = 0;
       while (token_pos < this.field_size_first_formula)
       {
           Ptg ptg = Ptg.createPtg(in);
           token_pos += ptg.getSize();
           field_rpn_token_1.push(ptg);
       }

       this.field_size_sec_formula = in.readShort(); 
       this.field_not_used_2 = in.readShort();

       //read sec formula data condition
       //Not sure if this was needed or not...
       try {
           in.skip(this.field_size_sec_formula);
       } catch(IOException e) {
           e.printStackTrace();
           throw new IllegalStateException(e.getMessage());
       }

       token_pos = 0;
       while (token_pos < this.field_size_sec_formula)
       {
           Ptg ptg = Ptg.createPtg(in);
           token_pos += ptg.getSize();
           field_rpn_token_2.push(ptg);
       }

       //read cell range address list with all affected ranges
       this.field_regions = new HSSFCellRangeAddress(in);
    }


    // --> start option flags
    /**
     * set the condition data type
     * @param type - condition data type
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public void setDataType(int type)
    {
        this.field_option_flags =  this.opt_data_type.setValue(this.field_option_flags, type);
    }

    /**
     * get the condition data type
     * @return the condition data type
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public int getDataType()
    {
       return this.opt_data_type.getValue(this.field_option_flags);
    }

    /**
     * set the condition error style
     * @param type - condition error style
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public void setErrorStyle(int style)
    {
        this.field_option_flags =  this.opt_error_style.setValue(this.field_option_flags, style);
    }

    /**
     * get the condition error style
     * @return the condition error style
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public int getErrorStyle()
    {
       return this.opt_error_style.getValue(this.field_option_flags);
    }

    /**
     * set if in list validations the string list is explicitly given in the formula
     * @param type - true if in list validations the string list is explicitly given in the formula; false otherwise
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public void setListExplicitFormula(boolean explicit)
    {
        this.field_option_flags = this.opt_string_list_formula.setBoolean(this.field_option_flags, explicit);
    }

    /**
     * return true if in list validations the string list is explicitly given in the formula, false otherwise
     * @return true if in list validations the string list is explicitly given in the formula, false otherwise
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public boolean getListExplicitFormula()
    {
       return (this.opt_string_list_formula.isSet(this.field_option_flags));
    }

    /**
     * set if empty values are allowed in cells
     * @param type - true if empty values are allowed in cells, false otherwise
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public void setEmptyCellAllowed(boolean allowed)
    {
        this.field_option_flags =  this.opt_empty_cell_allowed.setBoolean(this.field_option_flags, allowed);
    }

    /**
     * return true if empty values are allowed in cells, false otherwise
     * @return if empty values are allowed in cells, false otherwise
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public boolean getEmptyCellAllowed()
    {
       return (this.opt_empty_cell_allowed.isSet(this.field_option_flags));
    }

    /**
     * set if drop down arrow should be surppressed when list validation is used
     * @param type - true if drop down arrow should be surppressed when list validation is used, false otherwise
     * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
     */
    public void setSurppresDropdownArrow(boolean surppress)
    {
        this.field_option_flags =  this.opt_surppres_dropdown_arrow.setBoolean(this.field_option_flags, surppress);
    }