123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- /* ====================================================================
- 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.common;
-
- import java.util.Map;
- import java.util.function.Supplier;
-
- import org.apache.poi.common.Duplicatable;
- import org.apache.poi.common.usermodel.GenericRecord;
- import org.apache.poi.hssf.record.RecordInputStream;
- import org.apache.poi.ss.util.CellRangeAddress;
- import org.apache.poi.util.GenericRecordJsonWriter;
- import org.apache.poi.util.GenericRecordUtil;
- import org.apache.poi.util.LittleEndianOutput;
-
- /**
- * Title: FtrHeader (Future Record Header) common record part
- * <P>
- * This record part specifies a header for a Ftr (Future)
- * style record, which includes extra attributes above and
- * beyond those of a traditional record.
- */
- public final class FtrHeader implements Duplicatable, GenericRecord {
- /** This MUST match the type on the containing record */
- private short recordType;
- /** This is a FrtFlags */
- private short grbitFrt;
- /** The range of cells the parent record applies to, or 0 if N/A */
- private CellRangeAddress associatedRange;
-
- public FtrHeader() {
- associatedRange = new CellRangeAddress(0, 0, 0, 0);
- }
-
- public FtrHeader(FtrHeader other) {
- recordType = other.recordType;
- grbitFrt = other.grbitFrt;
- associatedRange = other.associatedRange.copy();
- }
-
- public FtrHeader(RecordInputStream in) {
- recordType = in.readShort();
- grbitFrt = in.readShort();
-
- associatedRange = new CellRangeAddress(in);
- }
-
- public String toString() {
- return GenericRecordJsonWriter.marshal(this);
- }
-
- public void serialize(LittleEndianOutput out) {
- out.writeShort(recordType);
- out.writeShort(grbitFrt);
- associatedRange.serialize(out);
- }
-
- public static int getDataSize() {
- return 12;
- }
-
- public short getRecordType() {
- return recordType;
- }
- public void setRecordType(short recordType) {
- this.recordType = recordType;
- }
-
- public short getGrbitFrt() {
- return grbitFrt;
- }
- public void setGrbitFrt(short grbitFrt) {
- this.grbitFrt = grbitFrt;
- }
-
- public CellRangeAddress getAssociatedRange() {
- return associatedRange;
- }
- public void setAssociatedRange(CellRangeAddress associatedRange) {
- this.associatedRange = associatedRange;
- }
-
- public FtrHeader copy() {
- return new FtrHeader(this);
- }
-
- @Override
- public Map<String, Supplier<?>> getGenericProperties() {
- return GenericRecordUtil.getGenericProperties(
- "recordType", this::getRecordType,
- "grbitFrt", this::getGrbitFrt,
- "associatedRange", this::getAssociatedRange
- );
- }
- }
|