vaadin-framework/src/com/itmill/toolkit/terminal/gwt/client/Caption.java

package com.itmill.toolkit.terminal.gwt.client;

import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.Event;
import com.google.gwt.user.client.ui.HTML;
import com.google.gwt.user.client.ui.PopupPanel;

public class Caption extends HTML {
	
	private Paintable owner;

	private Element errorIndicatorElement;
	
	private Element captionText;

	private ErrorMessage errorMessage;
	
	private PopupPanel errorContainer;
	
	/* Caption must be attached to a Paintable */
	private Caption(){};
	
	public Caption(Paintable component)  {
		super();
		owner = component;
		setStyleName("i-caption");
	}
	
	public void updateCaption(UIDL uidl) {
		setVisible(!uidl.getBooleanAttribute("invisible"));
		
		if(uidl.hasAttribute("error")) {
			UIDL errorUidl = uidl.getErrors();
			
			if(errorIndicatorElement == null) {
				errorIndicatorElement = DOM.createDiv();
				DOM.setElementProperty(errorIndicatorElement, "className", "i-errorindicator");
				DOM.insertChild(getElement(), errorIndicatorElement, 0);
			}
			
			errorMessage = new ErrorMessage();
			errorMessage.updateFromUIDL(errorUidl);
			
		} else if( errorIndicatorElement != null) {
			DOM.setStyleAttribute(errorIndicatorElement, "display", "none");
		}
		
		
		if(uidl.hasAttribute("caption")) {
			if(captionText == null) {
				captionText = DOM.createSpan();
				DOM.appendChild(getElement(), captionText);
			}
			DOM.setInnerText(captionText, uidl.getStringAttribute("caption"));
		}
		
		if(uidl.hasAttribute("description")) {
			if(captionText != null) {
				DOM.setElementProperty(captionText, "title", uidl.getStringAttribute("description"));
			} else {
				setTitle(uidl.getStringAttribute("description"));
			}
		}
		
	}
	
	public void onBrowserEvent(Event event) {
		Element target= DOM.eventGetTarget(event);
		if(errorIndicatorElement != null && DOM.compare(target, errorIndicatorElement)) {
			switch (DOM.eventGetType(event)) {
			case Event.ONMOUSEOVER:
				showErrorMessage();
				break;
			case Event.ONMOUSEOUT:
				hideErrorMessage();
				break;
			case Event.ONCLICK:
				ApplicationConnection.getConsole().
					log(DOM.getInnerHTML(errorMessage.getElement()));
			default:
				break;
			}
		}
	}

	private void hideErrorMessage() {
		if(errorContainer != null) {
			errorContainer.hide();
		}
	}

	private void showErrorMessage() {
		if(errorMessage != null) {
			if(errorContainer == null) {
				errorContainer = new PopupPanel();
				errorContainer.setWidget(errorMessage);
			}
			errorContainer.setPopupPosition(
					DOM.getAbsoluteLeft(errorIndicatorElement) +
						2*DOM.getElementPropertyInt(errorIndicatorElement, "offsetHeight"),
					DOM.getAbsoluteTop(errorIndicatorElement) + 
						2*DOM.getElementPropertyInt(errorIndicatorElement, "offsetHeight"));
			errorContainer.show();
		}
	}

	public static boolean isNeeded(UIDL uidl) {
		if (uidl.getStringAttribute("caption") != null) return true;
		if (uidl.hasAttribute("error"))
			return true;
		
		// TODO Description ??
		
		return false;
	}
	
	/**
	 * Returns Paintable for which this Caption
	 * belongs to.
	 * 
	 * @return owner Widget
	 */
	public Paintable getOwner() {
		return owner;
	}
}