com.icesoft.faces.component.panelpopup.PanelPopup 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.panelpopup;
import com.icesoft.faces.component.CSS_DEFAULT;
import com.icesoft.faces.component.ext.HtmlPanelGroup;
import com.icesoft.faces.component.ext.taglib.Util;
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 org.w3c.dom.Element;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.el.ValueBinding;
import java.util.Map;
/**
* PanelPopup is a JSF component class that represents an ICEfaces popup panel.
* The "header" and "body" named facets represent the components responsible for
* rendering the header and body of the popup panel. The component extends
* the ICEfaces extended HTMLPanelGroup. By default the component is
* rendered by the "com.icesoft.faces.PanelPopup" renderer type.
*
* @author Greg McCleary
* @version beta 1.0
*/
public class PanelPopup extends HtmlPanelGroup {
/**
* The component type.
*/
public static final String COMPONENT_TYPE = "com.icesoft.faces.PanelPopup";
/**
* The default renderer type.
*/
public static final String DEFAULT_RENDERER_TYPE = "com.icesoft.faces.PanelPopup";
/**
* The default resizable property is false. This unused attribute is here
* for future use.
*/
private static final boolean DEFAULT_RESIZABLE = false;
/**
* The default modal property is false.
*/
private static final boolean DEFAULT_MODAL = false;
/**
* The header facet name.
*/
private static final String HEADER_FACET = "header";
/**
* The body facet name.
*/
private static final String BODY_FACET = "body";
/**
* The current style class.
*/
private String styleClass = null;
/**
* The current style.
*/
private String style = null;
/**
* The current resizable state.
*/
private Boolean resizable = null;
/**
* The current modal state.
*/
private Boolean modal = null;
/**
* The current autoCentre state.
*/
private Boolean autoCentre = null;
/**
* The current clientOnly state.
*/
private Boolean clientOnly = null;
private Boolean positionOnLoadOnly = null;
private boolean dragged;
public boolean isAutoCentre() {
if (autoCentre != null) {
return autoCentre.booleanValue();
}
ValueBinding vb = getValueBinding("autoCentre");
Boolean boolVal = vb != null ? (Boolean) vb.getValue(getFacesContext())
: null;
return boolVal != null ? boolVal.booleanValue() : false;
}
public void setAutoCentre(boolean autoCentre) {
this.autoCentre = Boolean.valueOf(autoCentre);
}
public boolean isClientOnly() {
if (clientOnly != null) {
return clientOnly.booleanValue();
}
ValueBinding vb = getValueBinding("clientOnly");
Boolean boolVal = vb != null ? (Boolean) vb.getValue(getFacesContext())
: null;
return boolVal != null ? boolVal.booleanValue() : false;
}
public void setClientOnly(boolean clientOnly) {
this.clientOnly = Boolean.valueOf(clientOnly);
}
public boolean isPositionOnLoadOnly() {
if (positionOnLoadOnly != null) {
return positionOnLoadOnly.booleanValue();
}
ValueBinding vb = getValueBinding("positionOnLoadOnly");
Boolean boolVal = vb != null ? (Boolean) vb.getValue(getFacesContext())
: null;
return boolVal != null ? boolVal.booleanValue() : false;
}
public void setPositionOnLoadOnly(boolean positionOnLoadOnly) {
this.positionOnLoadOnly = Boolean.valueOf(positionOnLoadOnly);
}
private String autoPosition = null;
public String getAutoPosition() {
if (autoPosition != null) {
return autoPosition;
}
ValueBinding vb = getValueBinding("autoPosition");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
public void setAutoPosition(String val) {
this.autoPosition = val;
}
/**
* Creates an instance and sets renderer type to
* "com.icesoft.faces.PanelPopup".
*/
public PanelPopup() {
setRendererType(DEFAULT_RENDERER_TYPE);
JavascriptContext.includeLib(JavascriptContext.ICE_EXTRAS, FacesContext
.getCurrentInstance());
}
// typesafe facet getters
/**
* @return the "header" facet.
*/
public UIComponent getHeader() {
return (UIComponent) getFacet(HEADER_FACET);
}
/**
* @return the "body" facet.
*/
public UIComponent getBody() {
return (UIComponent) getFacet(BODY_FACET);
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.UIComponent#isRendered()
*/
public boolean isRendered() {
if (!Util.isRenderedOnUserRole(this)) {
stopModal();
return false;
}
boolean rendered = super.isRendered();
if (!rendered) {
stopModal();
}
return rendered;
}
private void stopModal() {
String caller = new Exception().getStackTrace()[2].getMethodName();
if ((caller.startsWith("encode") || caller.startsWith("render")) && isVisibilityChanged()) {
JavascriptContext.addJavascriptCall(getFacesContext(),
"Ice.modal.stop('" + getClientId(getFacesContext()) + "');");
}
}
/**
* @return the headerClass style class name.
*/
public String getHeaderClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.POPUP_DEFAULT_HEADER_CLASS);
}
/**
* @return the bodyClass style class name.
*/
public String getBodyClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.POPUP_DEFAULT_BODY_CLASS);
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.html.HtmlPanelGroup#setStyleClass(java.lang.String)
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.html.HtmlPanelGroup#getStyleClass()
*/
public String getStyleClass() {
return Util.getQualifiedStyleClass(this, styleClass,
CSS_DEFAULT.POPUP_BASE, "styleClass");
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.html.HtmlPanelGroup#getStyle()
*/
public String getStyle() {
if (style != null) {
return style;
}
ValueBinding vb = getValueBinding("style");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.html.HtmlPanelGroup#setStyle(java.lang.String)
*/
public void setStyle(String style) {
this.style = style;
}
/**
* Returns true if component is resizable. This method will always return
* false as the resizable functionality has not been implemented in the 1.0
* version.
*
* @return false
*/
public boolean isResizable() {
return false; // resizable functionality is not added yet
}
/**
* Sets the resizable attribute of the component. Note: The resizable
* function has not been implemented in the Beta relase.
*
* @param resizable a value of true will set the component to be resizable
*/
public void setResizable(boolean resizable) {
this.resizable = Boolean.valueOf(resizable);
}
/**
* @return true if the component is modal.
*/
public boolean isModal() {
if (modal != null) {
return modal.booleanValue();
}
ValueBinding vb = getValueBinding("modal");
Boolean boolVal = vb != null ? (Boolean) vb.getValue(getFacesContext())
: null;
return boolVal != null ? boolVal.booleanValue() : DEFAULT_MODAL;
}
/**
* @param modal a value of true sets the component to be modal
*/
public void setModal(boolean modal) {
this.modal = Boolean.valueOf(modal);
}
private transient Object values[];
/*
* (non-Javadoc)
*
* @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext)
*/
public Object saveState(FacesContext context) {
if (values == null) {
values = new Object[13];
}
values[0] = super.saveState(context);
values[1] = styleClass;
values[2] = style;
values[3] = resizable;
values[4] = modal;
values[5] = title;
values[6] = autoPosition;
values[7] = clientOnly;
values[8] = autoCentre;
values[9] = positionOnLoadOnly;
values[10] = Boolean.valueOf(dragged);
values[11] = runningModal;
values[12] = visibleBefore;
return ((Object) (values));
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext,
* java.lang.Object)
*/
public void restoreState(FacesContext context, Object state) {
Object values[] = (Object[]) state;
super.restoreState(context, values[0]);
styleClass = (String) values[1];
style = (String) values[2];
resizable = (Boolean) values[3];
modal = (Boolean) values[4];
title = (String) values[5];
autoPosition = (String) values[6];
clientOnly = (Boolean) values[7];
autoCentre = (Boolean) values[8];
positionOnLoadOnly = (Boolean) values[9];
dragged = ((Boolean) values[10]).booleanValue();
runningModal = (Boolean) values[11];
visibleBefore = ((Boolean) values[12]).booleanValue();
}
private String title = null;
/**
*
* Set the value of the title property.
*
*/
public void setTitle(String title) {
this.title = title;
}
/**
*
* Return the value of the title property.
*
*/
public String getTitle() {
if (title != null) {
return title;
}
ValueBinding vb = getValueBinding("title");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
public void applyStyle(FacesContext facesContext, Element root) {
String style = getStyle();
String display = "block";
if (!isVisible()) {
display = "none";
}
Map map = (Map) facesContext.getExternalContext().getSessionMap()
.get(CurrentStyle.class.getName());
if (map != null) {
String currentStyle = String.valueOf(map.get(getClientId(facesContext)));
if (!currentStyle.equals("null")) {
currentStyle = CustomComponentUtils.setPropertyValue
(currentStyle, "display", display, true);
map.put(getClientId(facesContext), currentStyle);
getAttributes()
.put("currentStyle", new CurrentStyle(currentStyle));
if (style != null) {
style = CustomComponentUtils.setPropertyValue(style,
"display", display, true);
}
}
}
if (style != null && style.length() > 0)
root.setAttribute(HTML.STYLE_ATTR, style);
else
root.removeAttribute(HTML.STYLE_ATTR);
CurrentStyle.apply(facesContext, this);
}
public boolean isDragged() {
return dragged;
}
public void setDragged(boolean dragged) {
this.dragged = dragged;
}
boolean visibleBefore = false;
public void processDecodes(FacesContext context) {
super.processDecodes(context);
//capture previous state
visibleBefore = isVisible();
}
public boolean isVisibilityChanged() {
return isVisible() != visibleBefore;
}
// ICE-3563 {
private Boolean runningModal = null;
protected boolean isRunningModal() {
if (runningModal == null) {
setRunningModal(isModal() && isVisible());
}
return runningModal.booleanValue();
}
protected void setRunningModal(boolean runningModal) {
this.runningModal = Boolean.valueOf(runningModal);
}
// }
}