com.hcl.domino.richtext.structures.CDFrameVariableData 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.structures;

import java.util.Optional;

import com.hcl.domino.richtext.records.CDFrame;
import com.hcl.domino.richtext.records.CDFrame.BorderAlignment;
import com.hcl.domino.richtext.records.CDFrame.TextAlignment;

/**
 * Variable data values of a {@link CDFrame} that store additional
 * frame properties
 * 
 * @author Karsten Lehmann
 */
public class CDFrameVariableData {
	private CDFrame cdFrame;
	private Optional captionFormula = Optional.empty();
	private Optional borderAlignment = Optional.empty();
	private Optional textAlign = Optional.empty();
	private int open;
	private Optional backgroundColor = Optional.empty();
	private Optional fontStyle = Optional.empty();
	private Optional textColor = Optional.empty();
	private Optional fontName = Optional.empty();
	private int sequenceNo;
	
	public CDFrameVariableData(CDFrame cdFrame) {
		this.cdFrame = cdFrame;
	}
	
	public CDFrame getParent() {
		return cdFrame;
	}
	
	public Optional getCaptionFormula() {
		return captionFormula;
	}

	public CDFrameVariableData setCaptionFormula(String captionFormula) {
		this.captionFormula = Optional.ofNullable(captionFormula);
		return this;
	}

	public Optional getBorderAlignment() {
		return borderAlignment;
	}

	public CDFrameVariableData setBorderAlignment(BorderAlignment borderAlignment) {
		this.borderAlignment = Optional.ofNullable(borderAlignment);
		return this;
	}

	/**
	 * Returns the text alignment within the caption border
	 * 
	 * @return alignment
	 */
	public Optional getTextAlignment() {
		return textAlign;
	}

	/**
	 * Sets the text alignment within the caption border
	 * 
	 * @param textAlign new alignment
	 * @return this frame data
	 */
	public CDFrameVariableData setTextAlignment(TextAlignment textAlign) {
		this.textAlign = Optional.ofNullable(textAlign);
		return this;
	}

	public int getOpen() {
		return open;
	}

	public CDFrameVariableData setOpen(int open) {
		this.open = open;
		return this;
	}

	public Optional getBackgroundColor() {
		return backgroundColor;
	}

	public CDFrameVariableData setBackgroundColor(ColorValue backgroundColor) {
		this.backgroundColor = Optional.ofNullable(backgroundColor);
		return this;
	}

	public Optional getFontStyle() {
		return fontStyle;
	}

	public CDFrameVariableData setFontStyle(FontStyle fontId) {
		this.fontStyle = Optional.ofNullable(fontId);
		return this;
	}

	public Optional getTextColor() {
		return textColor;
	}

	public CDFrameVariableData setTextColor(ColorValue textColor) {
		this.textColor = Optional.ofNullable(textColor);
		return this;
	}

	public Optional getFontName() {
		return fontName;
	}

	public CDFrameVariableData setFontName(String fontName) {
		this.fontName = Optional.ofNullable(fontName);
		return this;
	}

	public int getSequenceNo() {
		return sequenceNo;
	}

	public CDFrameVariableData setSequenceNo(int sequenceNo) {
		this.sequenceNo = sequenceNo;
		return this;
	}

	@Override
	public String toString() {
		return "CDFrameVariableData [captionFormula=" + captionFormula + ", unknownValue=" + borderAlignment //$NON-NLS-1$ //$NON-NLS-2$
				+ ", textAlign=" + textAlign + ", open=" + open + ", backgroundColor=" + backgroundColor //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
				+ ", fontStyle=" + fontStyle + ", textColor=" + textColor + ", fontName=" + fontName + ", sequenceNo=" //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
				+ sequenceNo + "]"; //$NON-NLS-1$
	}

	
}