Close.java

/*
 *  Copyright 2012 GWT-Bootstrap
 *
 *  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.github.gwtbootstrap.client.ui;

import com.github.gwtbootstrap.client.ui.base.HasType;
import com.github.gwtbootstrap.client.ui.constants.Constants;
import com.github.gwtbootstrap.client.ui.constants.DismissType;
import com.google.gwt.user.client.ui.Anchor;

//@formatter:off
/**
 * Icon ("×") that indicates that something can be closed.
 * 
 * <p>
 * <h3>UiBinder Usage:</h3>
 * 
 * {@code <b:Close />}
 * </p>
 * 
 * @since 2.0.4.0
 * 
 * @author Dominik Mayer
 * 
 * @see <a href="http://getbootstrap.com/2.3.2/components.html#misc">Bootstrap documentation</a>
 * @see Alert
 * @see AlertBlock
 * @see Modal
 */
//@formatter:on
public class Close extends Anchor implements HasType<DismissType> {

	/**
	 * Creates an icon without behavior.
	 */
	public Close() {
		setStyleName(Constants.CLOSE);
		setHTML(Constants.CLOSE_ICON);
	}

	/**
	 * Creates an icon that closes an associated widget.
	 * 
	 * @param dismiss
	 *            the type of widget to be closed
	 */
	public Close(DismissType dismiss) {
		this();
		setType(dismiss);
	}

	/**
	 * Sets the type of widget to be closed.
	 * 
	 * @param type
	 *            the type of widget to be closed
	 */
	public void setType(DismissType type) {
		getElement().setAttribute(Constants.DATA_DISMISS, type.get());
	}
}