org.dominokit.domino.ui.utils.HasHelperText Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation

There is a newer version: 2.0.3

/*
 * Copyright © 2019 Dominokit
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.dominokit.domino.ui.utils;

/**
 * The {@code HasHelperText} interface defines methods for setting and getting helper text for a
 * component.
 *
 * @param  The type of the component that can have helper text.
 */
public interface HasHelperText {

  /**
   * Sets the helper text for the component.
   *
   * @param helperText The helper text to be set.
   * @return The component with the helper text set.
   */
  T setHelperText(String helperText);

  /**
   * Gets the helper text currently associated with the component.
   *
   * @return The current helper text for the component.
   */
  String getHelperText();
}