com.phloc.html.hc.IHCButton Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-html Show documentation
There is a newer version: 4.4.9
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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 com.phloc.html.hc;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.url.ISimpleURL;
import com.phloc.html.hc.api.EHCButtonType;
import com.phloc.html.js.IJSCodeProvider;

public interface IHCButton > extends IHCElementWithChildren , IHCCanBeDisabled , IHCHasName 
{
  /**
   * @return The value of the button. May be null.
   */
  @Nullable
  String getValue ();

  /**
   * Set the value of the button.
   * 
   * @param sValue
   *        The value to set. May be null.
   * @return this
   */
  @Nonnull
  THISTYPE setValue (@Nullable String sValue);

  /**
   * @return The type of the button (button, submit or reset). Never
   *         null.
   */
  @Nonnull
  EHCButtonType getType ();

  /**
   * Set the type of the button.
   * 
   * @param eType
   *        The new type. May not be null.
   * @return this
   */
  @Nonnull
  THISTYPE setType (@Nonnull EHCButtonType eType);

  /**
   * Shortcut for setEventHandler(EJSEvent.ONCLICK, aOnClick)
   * 
   * @param aOnClick
   *        JS event to trigger
   * @return this
   */
  @Nonnull
  THISTYPE setOnClick (@Nullable IJSCodeProvider aOnClick);

  /**
   * Shortcut for setOnClick(JSHtml.windowLocationHref (aURL))
   * 
   * @param aURL
   *        URL to link to
   * @return this
   */
  @Nonnull
  THISTYPE setOnClick (@Nonnull ISimpleURL aURL);

  /**
   * Shortcut for addEventHandler(EJSEvent.ONCLICK, aOnClick)
   * 
   * @param aOnClick
   *        JS event to trigger
   * @return this
   */
  @Nonnull
  THISTYPE addOnClick (@Nullable IJSCodeProvider aOnClick);

  /**
   * Shortcut for addOnClick(JSHtml.windowLocationHref (aURL))
   * 
   * @param aURL
   *        URL to link to
   * @return this
   */
  @Nonnull
  THISTYPE addOnClick (@Nonnull ISimpleURL aURL);
}