com.hcl.domino.richtext.records.CDAreaElement 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.richtext.records;

import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
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.CDPoint;
import com.hcl.domino.richtext.structures.CDRect;
import com.hcl.domino.richtext.structures.MemoryStructureWrapperService;
import com.hcl.domino.richtext.structures.WSIG;

/**
 * Rich text record of type CDAREAELEMENT
 */
@StructureDefinition(name = "CDAREAELEMENT", members = {
    @StructureMember(name = "Header", type = WSIG.class),
    @StructureMember(name = "Flags", type = int.class),
    @StructureMember(name = "Shape", type = CDAreaElement.Shape.class),
    @StructureMember(name = "TabIndex", type = short.class, unsigned = true),
    @StructureMember(name = "AccessKey", type = short.class, unsigned = true),
    @StructureMember(name = "Reserved", type = byte[].class, length = 16)
})
public interface CDAreaElement extends RichTextRecord {

  enum Shape implements INumberEnum {
    RECTANGLE((short)RichTextConstants.AREA_SHAPE_RECT),
    CIRCLE((short)RichTextConstants.AREA_SHAPE_CIRCLE),
    POLYGON((short)RichTextConstants.AREA_SHAPE_POLYGON),
    DEFAULT((short)RichTextConstants.AREA_SHAPE_DEFAULT);
    
    private final short value;
    
    private Shape(short value) {
      this.value = value;
    }

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

    @Override
    public Short getValue() {
      return value;
    }
  }
  
  @StructureGetter("Header")
  @Override
  WSIG getHeader();
  
  @StructureGetter("Flags")
  int getFlags();
  
  @StructureSetter("Flags")
  CDAreaElement setFlags(int flags);
  
  @StructureGetter("Shape")
  Optional getShape();
  
  @StructureSetter("Shape")
  CDAreaElement setShape(Shape shape);
  
  @StructureGetter("Shape")
  short getShapeRaw();
  
  @StructureSetter("Shape")
  CDAreaElement setShapeRaw(short shape);
  
  @StructureGetter("TabIndex")
  int getTabIndex();
  
  @StructureSetter("TabIndex")
  CDAreaElement setTabIndex(int tabIndex);
  
  @StructureGetter("AccessKey")
  int getAccessKey();
  
  @StructureSetter("AccessKey")
  CDAreaElement setAccessKey(int accessKey);
  
  default  Optional getRectangle() {
    if (getShape().orElse(null) == Shape.RECTANGLE) {
      final MemoryStructureWrapperService wrapper = MemoryStructureWrapperService.get();
      
      return Optional.of(wrapper.wrapStructure(CDRect.class, this.getVariableData()));
    }
    
    return Optional.empty();
  }
  
  default  Optional getCircle() {
    if (getShape().orElse(null) == Shape.CIRCLE) {
      final MemoryStructureWrapperService wrapper = MemoryStructureWrapperService.get();
      
      return Optional.of(wrapper.wrapStructure(CDRect.class, this.getVariableData()));
    }
    
    return Optional.empty();
  }
  
  default  Optional> getPolygon() {
    if (getShape().orElse(null) == Shape.POLYGON) {
      final MemoryStructureWrapperService wrapper = MemoryStructureWrapperService.get();
      
      ByteBuffer buf = this.getVariableData();
      //first get number of points
      short numOfPoints = buf.getShort();
      final List result = new ArrayList<>(numOfPoints);
      for (int i=0; i polygon) {
    //set shape to rectangle
    setShape(Shape.POLYGON);
    
    final MemoryStructureWrapperService wrapper = MemoryStructureWrapperService.get();
    final int pointSize = wrapper.sizeOf(CDPoint.class);
    this.resizeVariableData(2+pointSize*polygon.size());
    ByteBuffer buf =  this.getVariableData();
    //write  number of points
    buf.putShort((short)polygon.size());
    //write points
    final byte[] newData = new byte[pointSize*polygon.size()];
    final ByteBuffer databuf = ByteBuffer.wrap(newData).order(ByteOrder.nativeOrder());
    for (final CDPoint point : polygon) {
      databuf.put(point.getData());
    }
    buf.put(newData);
    
    return this;
  }
}