com.hcl.domino.richtext.records.CDTableLabel 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.Collection;
import java.util.Set;

import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.StructureSupport;
import com.hcl.domino.richtext.RichTextConstants;
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 Jesse Gallagher
 * @since 1.0.34
 */
@StructureDefinition(
  name = "CDTABLELABEL",
  members = {
    @StructureMember(name = "Header", type = WSIG.class),
    @StructureMember(name = "Label", type = byte[].class, length = 128),
    @StructureMember(name = "Reserved", type = short[].class, length = 3),
    @StructureMember(name = "Flags", type = CDTableLabel.Flag.class, bitfield = true)
  }
)
public interface CDTableLabel extends RichTextRecord {
  enum Flag implements INumberEnum {
    ROWLABEL(RichTextConstants.CDTABLELABEL_ROWLABEL),
    TABLABEL(RichTextConstants.CDTABLELABEL_TABLABEL);
    private final short value;
    private Flag(short value) {
      this.value = value;
    }

    @Override
    public long getLongValue() {
      return value;
    }

    @Override
    public Short getValue() {
      return value;
    }
  }
  
  @StructureGetter("Header")
  @Override
  WSIG getHeader();
  
  @StructureGetter("Label")
  byte[] getLabelRaw();
  
  @StructureSetter("Label")
  CDTableLabel setLabelRaw(byte[] label);
  
  @StructureGetter("Flags")
  Set getFlags();
  
  @StructureSetter("Flags")
  CDTableLabel setFlags(Collection flags);
  
  default String getLabel() {
    return StructureSupport.readLmbcsValue(getLabelRaw());
  }
}