com.hcl.domino.design.format.ViewColumnFormat6 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api Show documentation
There is a newer version: 1.41.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.design.format;

import java.util.Collection;
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.NotesConstants;
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.MemoryStructureWrapperService;
import com.hcl.domino.richtext.structures.ResizableMemoryStructure;

/**
 * @author Jesse Gallagher
 * @since 1.0.24
 */
@StructureDefinition(name = "VIEW_COLUMN_FORMAT6", members = {
    @StructureMember(name = "Signature", type = short.class),
    // NB: this is a WORD in the API despite the "dw" prefix
    @StructureMember(name = "dwLength", type = short.class, unsigned = true),
    @StructureMember(name = "dwFlags6", type = ViewColumnFormat6.Flag.class, bitfield = true),
    @StructureMember(name = "SequenceNumber", type = short.class, unsigned = true),
    @StructureMember(name = "IfViewIsNarrowDo", type = NarrowViewPosition.class),
    @StructureMember(name = "wAttributesLength", type = short.class, unsigned = true),
    @StructureMember(name = "wPubFieldLength", type = short.class, unsigned = true),
    @StructureMember(name = "LineNumber", type = short.class, unsigned = true),
    @StructureMember(name = "TileViewer", type = TileViewerPosition.class),
    @StructureMember(name = "dwReserved", type = int[].class, length = 16),
})
public interface ViewColumnFormat6 extends ResizableMemoryStructure {
  
  public static ViewColumnFormat6 newInstanceWithDefaults() {
    ViewColumnFormat6 fmt = MemoryStructureWrapperService.get().newStructure(ViewColumnFormat6.class, 0);

    //TODO set defaults
    
    return fmt;
  }
  
  enum Flag implements INumberEnum {
    BeginWrapUnder(NotesConstants.VCF6_M_BeginWrapUnder),
    PublishColumn(NotesConstants.VCF6_M_PublishColumn),
    ExtendColWidthToAvailWindowWidth(NotesConstants.VCF6_M_ExtendColWidthToAvailWindowWidth),
    BuildCollationOnDemand(NotesConstants.VCF6_M_BuildCollationOnDemand),
    UserDefinableExtended(NotesConstants.VCF6_M_UserDefinableExtended),
    IgnorePrefixes(NotesConstants.VCF6_M_IgnorePrefixes),
    AbbreviatedDate(NotesConstants.VCF6_M_AbbreviatedDate),
    AbbreviatedDateSet(NotesConstants.VCF6_M_AbbreviatedDateSet);

    private final int value;

    Flag(final int value) {
      this.value = value;
    }

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

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

  @StructureGetter("Signature")
  short getSignature();

  @StructureSetter("Signature")
  ViewColumnFormat6 setSignature(short signature);

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

  @StructureSetter("dwLength")
  ViewColumnFormat6 setLength(int length);

  @StructureGetter("dwFlags6")
  Set getFlags();

  @StructureSetter("dwFlags6")
  ViewColumnFormat6 setFlags(Collection flags);

  default ViewColumnFormat6 setFlag(Flag flag, boolean b) {
    Set oldFlags = getFlags();
    if (b) {
      if (!oldFlags.contains(flag)) {
        Set newFlags = new HashSet<>(oldFlags);
        newFlags.add(flag);
        setFlags(newFlags);
      }
    }
    else {
      if (oldFlags.contains(flag)) {
        Set newFlags = oldFlags
            .stream()
            .filter(currFlag -> !flag.equals(currFlag))
            .collect(Collectors.toSet());
        setFlags(newFlags);
      }
    }
    return this;
  }
  
  @StructureGetter("SequenceNumber")
  int getSequenceNumber();

  @StructureSetter("SequenceNumber")
  ViewColumnFormat6 setSequenceNumber(int length);

  @StructureGetter("IfViewIsNarrowDo")
  Optional getIfViewIsNarrowDo();

  /**
   * Retrieves the if-narrow behavior as a raw {@code short}.
   * 
   * @return the if-narrow behavior as a {@code short}
   * @since 1.24.0
   */
  @StructureGetter("IfViewIsNarrowDo")
  short getIfViewIsNarrowDoRaw();

  @StructureSetter("IfViewIsNarrowDo")
  ViewColumnFormat6 setIfViewIsNarrowDo(NarrowViewPosition ifDo);

  /**
   * Sets the if-narrow behavior as a raw {@code short}.
   * 
   * @param ifDo the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("IfViewIsNarrowDo")
  ViewColumnFormat6 setIfViewIsNarrowDoRaw(short ifDo);

  @StructureGetter("wAttributesLength")
  int getAttributesLength();

  @StructureSetter("wAttributesLength")
  ViewColumnFormat6 setAttributesLength(int len);

  @StructureGetter("wPubFieldLength")
  int getPublishFieldNameLength();

  @StructureSetter("wPubFieldLength")
  ViewColumnFormat6 setPublishFieldNameLength(int len);

  @StructureGetter("LineNumber")
  int getLineNumber();

  @StructureSetter("LineNumber")
  ViewColumnFormat6 setLineNumber(int lineNo);

  @StructureGetter("TileViewer")
  Optional getTileViewer();

  /**
   * Retrieves the tile-viewer behavior as a raw {@code short}.
   * 
   * @return the tile-viewer behavior as a {@code short}
   * @since 1.24.0
   */
  @StructureGetter("TileViewer")
  short getTileViewerRaw();

  @StructureSetter("TileViewer")
  ViewColumnFormat6 setTileViewer(TileViewerPosition tileViewer);

  /**
   * Sets the tile-viewer behavior as a raw {@code short}.
   * 
   * @param tileViewer the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("TileViewer")
  ViewColumnFormat6 setTileViewerRaw(short tileViewer);

  default String getAttributes() {
    return StructureSupport.extractStringValue(this,
        0,
        this.getAttributesLength());
  }

  default ViewColumnFormat6 setAttributes(final String attributes) {
    return StructureSupport.writeStringValue(
        this,
        0,
        this.getAttributesLength(),
        attributes,
        (final int newLen) -> {
          this.setLength(148 + newLen + this.getPublishFieldNameLength());
          this.setAttributesLength(newLen);
        });
  }

  default String getPublishFieldName() {
    return StructureSupport.extractStringValue(this,
        this.getAttributesLength(),
        this.getPublishFieldNameLength());
  }

  default ViewColumnFormat6 setPublishFieldName(final String name) {
    return StructureSupport.writeStringValue(
        this,
        this.getAttributesLength(),
        this.getPublishFieldNameLength(),
        name,
        (final int newLen) -> {
          this.setLength(148 + this.getAttributesLength() + newLen);
          this.setPublishFieldNameLength(newLen);
        });
  }
}