com.hcl.domino.design.GenericFormOrSubform 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;

import java.util.List;
import java.util.Map;

import com.hcl.domino.richtext.FormField;

/**
 * Represents properties common between Forms and Subforms.
 * 
 * @param  the more-specific interface
 */
public interface GenericFormOrSubform> extends GenericPageElement.ScriptablePageElement,
  DesignElement.NamedDesignElement {

  T addField();

  List getExplicitSubformRecursive();

  List getFields();

  List getSubforms();

  T removeField();

  void swapFields(final int indexA, final int indexB);
  
  /**
   * Determines whether fields on this form or subform should be included in the database's field index.
   * 
   * @return {@code true} if fields on this form or subform should be added to the index;
   *         {@code false} otherwise
   * @since 1.0.33
   */
  boolean isIncludeFieldsInIndex();
  
  /**
   * Retrieves the LotusScript code associated with each field on the form.
   * 
   * @return a {@link Map} of field names to IDE-format LotusScript blocks
   * @since 1.0.34
   */
  Map getFieldLotusScript();
}