com.hcl.domino.richtext.records.CDHRule 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.Optional;
import java.util.Set;
import com.hcl.domino.data.StandardColors;
import com.hcl.domino.misc.DominoEnumUtil;
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.WSIG;

@StructureDefinition(name = "CDHRule", members = {
    @StructureMember(name = "Header", type = WSIG.class),
    @StructureMember(name = "Flags", type = CDHRule.Flag.class, bitfield = true),
    @StructureMember(name = "Width", type = short.class, unsigned = true),
    @StructureMember(name = "Height", type = short.class, unsigned = true),
    @StructureMember(name = "Color", type = short.class, unsigned = true),
    @StructureMember(name = "GradientColor", type = short.class, unsigned = true)
})
public interface CDHRule extends RichTextRecord{
  enum Flag implements INumberEnum {

    HRULE_FLAG_USECOLOR(RichTextConstants.HRULE_FLAG_USECOLOR),
    HRULE_FLAG_USEGRADIENT(RichTextConstants.HRULE_FLAG_USEGRADIENT),
    HRULE_FLAG_FITTOWINDOW(RichTextConstants.HRULE_FLAG_FITTOWINDOW),
    HRULE_FLAG_NOSHADOW(RichTextConstants.HRULE_FLAG_NOSHADOW);
    private final int value;
    private Flag(int value) {
      this.value = value;
    }

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

    @Override
    public Integer getValue() {
      return value;
    }
  }
  
  @StructureGetter("Header")
  @Override
  WSIG getHeader();
  
  @StructureGetter("Width")
  int getWidth();
  
  @StructureSetter("Width")
  CDHRule setWidth(int width);
  
  @StructureGetter("Height")
  int getHeight();
 
  @StructureSetter("Height")
  CDHRule setHeight(int height);
  
  @StructureGetter("Color")
  int getColorRaw();
  
  default Optional getColor() {
    return DominoEnumUtil.valueOf(StandardColors.class, getColorRaw());
  }
  
  @StructureSetter("Color")
  CDHRule setColorRaw(int colorRaw);
  
  default CDHRule setColor(StandardColors color) {
	  return setColorRaw(color.getValue());
  }
  
  @StructureGetter("GradientColor")
  int getGradientColorRaw();
  
  default Optional getGradientColor() {
    return DominoEnumUtil.valueOf(StandardColors.class, getGradientColorRaw());
  }
  
  @StructureSetter("GradientColor")
  CDHRule setGradientColorRaw(int gradientColorRaw);
  
  default CDHRule setGradientColor(StandardColors gradientColor) {
	  return setGradientColorRaw(gradientColor.getValue());
  }
  
  @StructureGetter("Flags")
  Set getFlags();
  
  @StructureSetter("Flags")
  CDHRule setFlags(Collection flags);
}