com.hcl.domino.richtext.records.CDPabHide Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation

There is a newer version: 1.44.0

/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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 com.hcl.domino.richtext.records;

import java.util.function.IntConsumer;

import com.hcl.domino.misc.StructureSupport;
import com.hcl.domino.richtext.annotation.StructureDefinition;
import com.hcl.domino.richtext.annotation.StructureGetter;
import com.hcl.domino.richtext.annotation.StructureMember;
import com.hcl.domino.richtext.annotation.StructureSetter;
import com.hcl.domino.richtext.structures.WSIG;

/**
 * @author Karsten Lehmann
 * @since 1.0.32
 */
@StructureDefinition(name = "CDPABHIDE", members = {
		@StructureMember(name = "Header", type = WSIG.class),
		@StructureMember(name = "PABID", type = short.class, unsigned = true),
		@StructureMember(name = "Reserved", type = byte[].class, length = 8)
})
public interface CDPabHide extends RichTextRecord {

	@StructureGetter("PABID")
	int getPabId();

	@StructureSetter("PABID")
	CDPabHide setPabId(int id);

	@StructureGetter("Reserved")
	byte[] getReserved();

	@StructureSetter("Reserved")
	CDPabHide setReserved(byte[] reserved);

	default int getFormulaLength() {
		return getCDRecordLength() - getRecordHeaderLength() - 8 - 2;
	}
	
	default String getFormula() {
		return StructureSupport.extractCompiledFormula(this, 0, getFormulaLength());
	}

	default void setFormula(String formula) {
		StructureSupport.writeCompiledFormula(this, 0, getFormulaLength(), formula, (IntConsumer) null);
	}
	
}