com.helger.bootstrap3.well.BootstrapWell Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-bootstrap3 Show documentation
Library wrapping Bootstrap 3 controls as Java web application components
There is a newer version: 2.0.2
/**
 * Copyright (C) 2014 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.bootstrap3.well;

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

import com.helger.bootstrap3.CBootstrapCSS;
import com.helger.commons.ValueEnforcer;
import com.helger.html.hc.IHCNode;
import com.helger.html.hc.html.AbstractHCDiv;

/**
 * Wrapper for a Bootstrap3 well.
 *
 * @author Philip Helger
 */
public class BootstrapWell extends AbstractHCDiv 
{
  private final EBootstrapWellType m_eType;

  public BootstrapWell ()
  {
    this (EBootstrapWellType.DEFAULT);
  }

  /**
   * Create a new Well element
   *
   * @param eType
   *        well type to use. May not be null.
   */
  public BootstrapWell (@Nonnull final EBootstrapWellType eType)
  {
    ValueEnforcer.notNull (eType, "Type");

    addClasses (CBootstrapCSS.WELL, eType);
    m_eType = eType;
  }

  @Nonnull
  public EBootstrapWellType getType ()
  {
    return m_eType;
  }

  /**
   * Create a new element with the passed child text
   *
   * @param sChild
   *        The child to be appended. May be null
   * @return The created BootstrapWell element and never null
   */
  @Nonnull
  public static BootstrapWell create (@Nullable final String sChild)
  {
    return new BootstrapWell ().addChild (sChild);
  }

  /**
   * Create a new element with the passed child texts
   *
   * @param aChildren
   *        The child texts to be appended. May be null
   * @return The created BootstrapWell element and never null
   */
  @Nonnull
  public static BootstrapWell create (@Nullable final String... aChildren)
  {
    return new BootstrapWell ().addChildren (aChildren);
  }

  /**
   * Create a new element with the passed child node
   *
   * @param aChild
   *        The child node to be appended. May be null
   * @return The created BootstrapWell element and never null
   */
  @Nonnull
  public static BootstrapWell create (@Nullable final IHCNode aChild)
  {
    return new BootstrapWell ().addChild (aChild);
  }

  /**
   * Create a new element with the passed child nodes
   *
   * @param aChildren
   *        The child nodes to be appended. May be null
   * @return The created BootstrapWell element and never null
   */
  @Nonnull
  public static BootstrapWell create (@Nullable final IHCNode... aChildren)
  {
    return new BootstrapWell ().addChildren (aChildren);
  }

  /**
   * Create a new element with the passed child nodes
   *
   * @param aChildren
   *        The child nodes to be appended. May be null
   * @return The created BootstrapWell element and never null
   */
  @Nonnull
  public static BootstrapWell create (@Nullable final Iterable  aChildren)
  {
    return new BootstrapWell ().addChildren (aChildren);
  }
}