com.icesoft.faces.component.paneltooltip.PanelTooltip Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
/*
* Copyright 2004-2012 ICEsoft Technologies Canada Corp.
*
* 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.icesoft.faces.component.paneltooltip;
import com.icesoft.faces.component.CSS_DEFAULT;
import com.icesoft.faces.component.DisplayEvent;
import com.icesoft.faces.component.ext.HtmlPanelGroup;
import com.icesoft.faces.component.ext.taglib.Util;
import com.icesoft.faces.component.panelpopup.PanelPopup;
import com.icesoft.faces.component.util.CustomComponentUtils;
import com.icesoft.faces.context.effects.CurrentStyle;
import com.icesoft.faces.context.effects.JavascriptContext;
import com.icesoft.faces.renderkit.dom_html_basic.HTML;
import com.icesoft.util.CoreComponentUtils;
import org.w3c.dom.Element;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;
import javax.faces.el.ValueBinding;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import java.io.IOException;
import java.util.Map;
public class PanelTooltip extends PanelPopup {
/**
* The component type.
*/
public static final String COMPONENT_TYPE = "com.icesoft.faces.PanelTooltip";
/**
* The default renderer type.
*/
public static final String DEFAULT_RENDERER_TYPE =
"com.icesoft.faces.PanelTooltipRenderer";
public static String ICE_TOOLTIP_INFO = "iceTooltipInfo";
private Integer hoverDelay;
private String hideOn;
private transient UIComponent tooltipSrcComponent;
private String styleClass = null;
private MethodBinding displayListener;
private String displayOn;
private Boolean moveWithMouse;
public PanelTooltip() {
setRendererType(DEFAULT_RENDERER_TYPE);
JavascriptContext.includeLib(JavascriptContext.ICE_EXTRAS,
FacesContext.getCurrentInstance());
}
public void encodeBegin(FacesContext context) throws IOException {
super.encodeBegin(context);
setValueChangeFired(false);
}
public int getHoverDelay() {
if (hoverDelay != null) {
return hoverDelay.intValue();
}
ValueBinding vb = getValueBinding("hoverDelay");
return vb != null ? ((Integer) vb.getValue(getFacesContext())).intValue() : 500;
}
public void setHoverDelay(int hoverDelay) {
this.hoverDelay = new Integer(hoverDelay);
}
public String getHideOn() {
if (hideOn != null) {
return hideOn;
}
ValueBinding vb = getValueBinding("hideOn");
return vb != null ? (String) vb.getValue(getFacesContext()) : "mouseout";
}
public void setHideOn(String hideOn) {
this.hideOn = hideOn;
}
/**
* @return true if the tooltip is dynamic.
*/
public boolean isDynamic() {
//if the tooltip is draggable its mean its dynamic as well
if (isDraggable() ||
displayListener != null ||
getValueBinding("visible") != null) {
return true;
} else {
return false;
}
}
/**
* @deprecated
*/
public UIComponent getTooltipSrcComponent() {
if (tooltipSrcComponent != null) {
return tooltipSrcComponent;
}
ValueBinding vb = getValueBinding("tooltipSrcComponent");
return vb != null ? (UIComponent) vb.getValue(getFacesContext()) : null;
}
/**
* @deprecated
*/
public void setTooltipSrcComponent(UIComponent tooltipSrcComponent) {
this.tooltipSrcComponent = tooltipSrcComponent;
}
/* (non-Javadoc)
* @see javax.faces.component.html.HtmlPanelGroup#getStyleClass()
*/
public String getStyleClass() {
return Util.getQualifiedStyleClass(this,
styleClass,
CSS_DEFAULT.TOOLTIP_BASE,
"styleClass");
}
/* (non-Javadoc)
* @see javax.faces.component.html.HtmlPanelGroup#setStyleClass(java.lang.String)
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
public void updateModal(FacesContext context) {
ValueBinding vb = getValueBinding("tooltipSrcComponent");
if (vb != null) {
vb.setValue(context, tooltipSrcComponent);
}
}
public void processUpdates(FacesContext context) {
ValueBinding vb = getValueBinding("visible");
if (vb != null) {
Map map = (Map) context.getExternalContext().getSessionMap()
.get(CurrentStyle.class.getName());
if (isValueChangeFired() || (map != null && map.containsKey(getClientId(context)))) {
vb.setValue(context, new Boolean("show".equals(getTooltipInfo().getState())));
}
}
if (visible != null) {
visible = new Boolean("show".equals(getTooltipInfo().getState()));
}
super.processUpdates(context);
}
public void applyStyle(FacesContext facesContext, Element root) {
super.applyStyle(facesContext, root);
String updatedStyle = root.getAttribute(HTML.STYLE_ATTR);
if (isDynamic() && cssUpdateReceived(facesContext)) {
String y = CustomComponentUtils.getCssPropertyValue(updatedStyle, "top");
String x = CustomComponentUtils.getCssPropertyValue(updatedStyle, "left");
if (y != null) setTooltipY(y);
if (x != null) setTooltipX(x);
}
if (!isDynamic() && !isInitialized()) {
updatedStyle = CustomComponentUtils.setPropertyValue(updatedStyle, "visibility", "hidden", true);
updatedStyle = CustomComponentUtils.setPropertyValue(updatedStyle, "display", "none", true);
setInitialized(true);
}
if (isDynamic()) {
updatedStyle = CustomComponentUtils.setPropertyValue(updatedStyle, "position", "absolute", true);
}
//value change fired must be a dynamic panelPopup
if (isValueChangeFired() || (isDynamic()
&& !cssUpdateReceived(facesContext))) {
setValueChangeFired(false);
if (getState().equals("show")) {
updatedStyle = CustomComponentUtils.setPropertyValue(updatedStyle, "top", getTooltipY(), true);
updatedStyle = CustomComponentUtils.setPropertyValue(updatedStyle, "left", getTooltipX(), true);
JavascriptContext.addJavascriptCall(facesContext, "ToolTipPanelPopupUtil.showPopup('" + root.getAttribute("id") + "'," + getTooltipX().replace("px", "") + "," + getTooltipY().replace("px", "") + ");");
}
}
root.setAttribute(HTML.STYLE_ATTR, updatedStyle);
}
void setInitialized(boolean initialized) {
this.getAttributes().put("comp-initialized", String.valueOf(initialized));
}
boolean isInitialized() {
return Boolean.getBoolean(String.valueOf(this.getAttributes().get("comp-initialized")));
}
private boolean cssUpdateReceived(FacesContext facesContext) {
Map requestMap = facesContext.getExternalContext().getRequestParameterMap();
if (requestMap == null ||
!requestMap.containsKey(CurrentStyle.CSS_UPDATE_FIELD)) {
return false;
}
String CSS_UPDATE = String.valueOf(requestMap.get(CurrentStyle.CSS_UPDATE_FIELD));
String clientId = getClientId(facesContext);
if (CSS_UPDATE.startsWith(clientId)) {
return true;
}
return false;
}
public void decode(FacesContext context) {
super.decode(context);
}
public static void decodeTooltip(FacesContext facesContext,
UIComponent target) {
Map requestMap = facesContext.getExternalContext().getRequestParameterMap();
if (requestMap.containsKey(ICE_TOOLTIP_INFO)) {
populateTooltipInfo(facesContext,
target,
String.valueOf(requestMap.get(ICE_TOOLTIP_INFO)));
}
}
public static void populateTooltipInfo(FacesContext facesContext,
UIComponent target,
String tooltipinfo
) {
String tooltipId = ((HtmlPanelGroup) target).getPanelTooltip();
Object contextValue = ((HtmlPanelGroup) target).getContextValue();
UIComponent tooltipComponent = CoreComponentUtils.findComponent(tooltipId, target);
String tooltipClientId = tooltipComponent.getClientId(facesContext);
String[] entries = tooltipinfo.split(";");
if (entries.length == 6) {
if (!entries[0].split("=")[1].equals(tooltipClientId)) return;
TooltipInfo tooltipInfo = getTooltipInfo(tooltipComponent,
tooltipClientId);
tooltipInfo.populateValues(entries);
if (entries[1].split("=")[1].equals(target.getClientId(facesContext))) {
target.queueEvent(new DisplayEvent(tooltipComponent,
target,
contextValue,
"show".equalsIgnoreCase(tooltipInfo.getState())
));
}
}
}
String getState() {
ValueBinding vb = getValueBinding("state");
return vb != null ? (String) vb.getValue(getFacesContext()) :
getTooltipInfo().getState();
}
void setState(String state) {
getTooltipInfo().setState(state);
}
String getTooltipSrcComp() {
return getTooltipInfo().getSrc();
}
String getTooltipX() {
return getTooltipInfo().getX();
}
String getTooltipY() {
return getTooltipInfo().getY();
}
void setTooltipX(String x) {
getTooltipInfo().setX(x);
}
void setTooltipY(String y) {
getTooltipInfo().setY(y);
}
void setValueChangeFired(boolean eventFired) {
getTooltipInfo().setEventFired(eventFired);
}
boolean isValueChangeFired() {
return getTooltipInfo().isEventFired();
}
boolean isDraggable() {
return "true".equalsIgnoreCase(getDraggable());
}
void removeTooltipFromVisibleList(FacesContext facesContext) {
boolean oldValue = "show".equals(getTooltipInfo().getState());
boolean show = isVisible();
if (!show && oldValue) {
//app is trying to hide the tooltip, synch the client
setState(isVisible() ? "show" : "hide");
JavascriptContext.addJavascriptCall(facesContext, "ToolTipPanelPopupUtil.removeFromVisibleList('" + getClientId(facesContext) + "');");
}
}
public static TooltipInfo getTooltipInfo(UIComponent tooltipComponent, String tooltipClientId) {
if (!tooltipComponent.getAttributes().containsKey("tooltip" + tooltipClientId)) {
tooltipComponent.getAttributes().put("tooltip" + tooltipClientId, new TooltipInfo());
}
return ((TooltipInfo) tooltipComponent.getAttributes().get("tooltip" + tooltipClientId));
}
TooltipInfo getTooltipInfo() {
if (!this.getAttributes().containsKey("tooltip" + getClientId(getFacesContext()))) {
this.getAttributes().put("tooltip" + getClientId(getFacesContext()), new TooltipInfo());
}
return ((TooltipInfo) this.getAttributes().get("tooltip" + getClientId(getFacesContext())));
}
/**
* Return the value of the displayListener property.
*/
public MethodBinding getDisplayListener() {
return displayListener;
}
/**
* Set the value of the displayListener property.
*/
public void setDisplayListener(MethodBinding displayListener) {
this.displayListener = displayListener;
}
public void broadcast(FacesEvent event)
throws AbortProcessingException {
super.broadcast(event);
if (displayListener != null) {
Object[] displayEvent = {(DisplayEvent) event};
displayListener.invoke(getFacesContext(), displayEvent);
}
}
/**
* Return the value of the visible property.
*/
public boolean isVisible() {
if (visible != null) {
return visible.booleanValue();
}
ValueBinding vb = getValueBinding("visible");
Boolean boolVal =
vb != null ? (Boolean) vb.getValue(getFacesContext()) : null;
return boolVal != null ? boolVal.booleanValue() : "show".equals(getTooltipInfo().getState());
}
private transient Object states[];
public void restoreState(FacesContext context, Object state) {
states = (Object[]) state;
super.restoreState(context, states[0]);
displayListener = (MethodBinding) restoreAttachedState(context, states[1]);
styleClass = (String) states[2];
hideOn = (String) states[3];
hoverDelay = (Integer) states[4];
displayOn = (String) states[5];
moveWithMouse = (Boolean) states[6];
}
public Object saveState(FacesContext context) {
if (states == null) {
states = new Object[7];
}
states[0] = super.saveState(context);
states[1] = saveAttachedState(context, displayListener);
states[2] = styleClass;
states[3] = hideOn;
states[4] = hoverDelay;
states[5] = displayOn;
states[6] = moveWithMouse;
return states;
}
public void setDisplayOn(String displayOn) {
this.displayOn = displayOn;
}
public String getDisplayOn() {
if (displayOn != null) {
return displayOn;
}
ValueBinding vb = getValueBinding("displayOn");
if (vb != null && vb.getValue(getFacesContext()) != null) {
return (String) vb.getValue(getFacesContext());
}
return "hover";
}
public boolean isMoveWithMouse() {
if (moveWithMouse != null) return moveWithMouse.booleanValue();
ValueBinding vb = getValueBinding("moveWithMouse");
if (vb == null) return false;
Object o = vb.getValue(getFacesContext());
if (o == null) return false;
return (Boolean.valueOf(o.toString())).booleanValue();
}
public void setMoveWithMouse(boolean moveWithMouse) {
this.moveWithMouse = Boolean.valueOf(moveWithMouse);
}
}