com.hcl.domino.richtext.records.CDCaption 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.nio.ByteBuffer;
import java.util.Optional;
import com.hcl.domino.data.NativeItemCoder;
import com.hcl.domino.misc.INumberEnum;
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.ColorValue;
import com.hcl.domino.richtext.structures.FontStyle;
import com.hcl.domino.richtext.structures.WSIG;

/**
 * @author Jesse Gallagher
 * @since 1.0.15
 */
@StructureDefinition(name = "CDCAPTION", members = {
    @StructureMember(name = "Header", type = WSIG.class),
    @StructureMember(name = "wLength", type = short.class, unsigned = true),
    @StructureMember(name = "Position", type = CDCaption.Position.class),
    @StructureMember(name = "FontID", type = FontStyle.class),
    @StructureMember(name = "FontColor", type = ColorValue.class),
    @StructureMember(name = "Reserved", type = byte[].class, length = 11)
})
public interface CDCaption extends RichTextRecord {
  enum Position implements INumberEnum {
    BELOW_CENTER(RichTextConstants.CAPTION_POSITION_BELOW_CENTER),
    MIDDLE_CENTER(RichTextConstants.CAPTION_POSITION_MIDDLE_CENTER);

    private final byte value;

    Position(final byte value) {
      this.value = value;
    }

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

    @Override
    public Byte getValue() {
      return this.value;
    }
  }

  @StructureGetter("FontColor")
  ColorValue getFontColor();

  @StructureGetter("FontID")
  FontStyle getFontID();

  @StructureGetter("Header")
  @Override
  WSIG getHeader();

  @StructureGetter("wLength")
  int getLength();

  @StructureGetter("Position")
  Optional getPosition();

  /**
   * Retrieves the position as a raw {@code byte}.
   * 
   * @return the position as a {@code byte}
   * @since 1.24.0
   */
  @StructureGetter("Position")
  byte getPositionRaw();

  /**
   * Stores the text for this caption in the variable data portion of this record.
   * 
   * The buffer will be resized, if necessary, to hold the text value.
   * 
   * 
   * This method also sets the {@code wLength} property to the appropriate value.
   * 
   *
   * @param captionText the caption text to set
   * @return this record
   */
  default CDCaption setCaptionText(final String captionText) {
    final byte[] captionTextBytes = captionText.getBytes(NativeItemCoder.get().getLmbcsCharset());
    this.resizeVariableData(captionTextBytes.length);
    this.setLength(captionTextBytes.length);

    final ByteBuffer buf = this.getVariableData();
    buf.put(captionTextBytes);
    return this;
  }

  @StructureSetter("wLength")
  CDCaption setLength(int length);

  @StructureSetter("Position")
  CDCaption setPosition(Position position);

  /**
   * Sets the position as a raw {@code byte}.
   * 
   * @param position the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("Position")
  CDCaption setPositionRaw(byte position);
}