| /* ==================================================================== |
| 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.apache.poi.hssf.record; |
| |
| import java.util.Map; |
| import java.util.function.Supplier; |
| import java.util.stream.Stream; |
| |
| import org.apache.poi.hssf.util.CellRangeAddress8Bit; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| /** |
| * Shows the user's selection on the sheet for write set num refs to 0 |
| */ |
| public final class SelectionRecord extends StandardRecord { |
| public static final short sid = 0x001D; |
| |
| |
| private byte field_1_pane; |
| private int field_2_row_active_cell; |
| private int field_3_col_active_cell; |
| private int field_4_active_cell_ref_index; |
| private CellRangeAddress8Bit[] field_6_refs; |
| |
| public SelectionRecord(SelectionRecord other) { |
| super(other); |
| field_1_pane = other.field_1_pane; |
| field_2_row_active_cell = other.field_2_row_active_cell; |
| field_3_col_active_cell = other.field_3_col_active_cell; |
| field_4_active_cell_ref_index = other.field_4_active_cell_ref_index; |
| field_6_refs = (other.field_6_refs == null) ? null |
| : Stream.of(other.field_6_refs).map(CellRangeAddress8Bit::copy).toArray(CellRangeAddress8Bit[]::new); |
| } |
| |
| /** |
| * Creates a default selection record (cell A1, in pane ID 3) |
| * |
| * @param activeCellRow the active cells row index |
| * @param activeCellCol the active cells column index |
| */ |
| public SelectionRecord(int activeCellRow, int activeCellCol) { |
| field_1_pane = 3; // pane id 3 is always present. see OOO sec 5.75 'PANE' |
| field_2_row_active_cell = activeCellRow; |
| field_3_col_active_cell = activeCellCol; |
| field_4_active_cell_ref_index = 0; |
| field_6_refs = new CellRangeAddress8Bit[] { |
| new CellRangeAddress8Bit(activeCellRow, activeCellRow, activeCellCol, activeCellCol), |
| }; |
| } |
| |
| public SelectionRecord(RecordInputStream in) { |
| field_1_pane = in.readByte(); |
| field_2_row_active_cell = in.readUShort(); |
| field_3_col_active_cell = in.readShort(); |
| field_4_active_cell_ref_index = in.readShort(); |
| int field_5_num_refs = in.readUShort(); |
| |
| field_6_refs = new CellRangeAddress8Bit[field_5_num_refs]; |
| for (int i = 0; i < field_6_refs.length; i++) { |
| field_6_refs[i] = new CellRangeAddress8Bit(in); |
| } |
| } |
| |
| /** |
| * set which window pane this is for |
| * @param pane the window pane |
| */ |
| public void setPane(byte pane) { |
| field_1_pane = pane; |
| } |
| |
| /** |
| * set the active cell's row |
| * @param row number of active cell |
| */ |
| public void setActiveCellRow(int row) { |
| field_2_row_active_cell = row; |
| resetField6(); |
| } |
| |
| /** |
| * set the active cell's col |
| * @param col number of active cell |
| */ |
| public void setActiveCellCol(short col) { |
| field_3_col_active_cell = col; |
| resetField6(); |
| } |
| |
| private void resetField6() { |
| // this is necessary in Excel to actually make Workbook.setActiveCell() take effect |
| field_6_refs = new CellRangeAddress8Bit[] { |
| new CellRangeAddress8Bit(field_2_row_active_cell, field_2_row_active_cell, field_3_col_active_cell, field_3_col_active_cell), |
| }; |
| } |
| |
| /** |
| * set the active cell's reference number |
| * @param ref number of active cell |
| */ |
| public void setActiveCellRef(short ref) { |
| field_4_active_cell_ref_index = ref; |
| } |
| |
| /** |
| * @return the pane ID which window pane this is for |
| */ |
| public byte getPane() { |
| return field_1_pane; |
| } |
| |
| /** |
| * get the active cell's row |
| * @return row number of active cell |
| */ |
| public int getActiveCellRow() { |
| return field_2_row_active_cell; |
| } |
| |
| /** |
| * get the active cell's col |
| * @return col number of active cell |
| */ |
| public int getActiveCellCol() { |
| return field_3_col_active_cell; |
| } |
| |
| /** |
| * get the active cell's reference number |
| * @return ref number of active cell |
| */ |
| public int getActiveCellRef() { |
| return field_4_active_cell_ref_index; |
| } |
| |
| @Override |
| protected int getDataSize() { |
| return 9 // 1 byte + 4 shorts |
| + CellRangeAddress8Bit.getEncodedSize(field_6_refs.length); |
| } |
| @Override |
| public void serialize(LittleEndianOutput out) { |
| out.writeByte(getPane()); |
| out.writeShort(getActiveCellRow()); |
| out.writeShort(getActiveCellCol()); |
| out.writeShort(getActiveCellRef()); |
| int nRefs = field_6_refs.length; |
| out.writeShort(nRefs); |
| for (CellRangeAddress8Bit field_6_ref : field_6_refs) { |
| field_6_ref.serialize(out); |
| } |
| } |
| |
| @Override |
| public short getSid() { |
| return sid; |
| } |
| |
| @Override |
| public SelectionRecord copy() { |
| return new SelectionRecord(this); |
| } |
| |
| @Override |
| public HSSFRecordTypes getGenericRecordType() { |
| return HSSFRecordTypes.SELECTION; |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "pane", this::getPane, |
| "activeCellRow", this::getActiveCellRow, |
| "activeCellCol", this::getActiveCellCol, |
| "activeCellRef", this::getActiveCellRef, |
| "refs", () -> field_6_refs |
| ); |
| } |
| } |