com.icesoft.faces.component.outputprogress.OutputProgress 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.outputprogress;
import com.icesoft.faces.component.CSS_DEFAULT;
import com.icesoft.faces.component.ext.taglib.Util;
import com.icesoft.faces.renderkit.dom_html_basic.HTML;
import org.icefaces.impl.util.DOMUtils;
import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
import javax.faces.el.ValueBinding;
/**
* OutputProgress is a JSF component class repersenting the ICEfaces progress
* bar. This component can be used to output progress information to users when
* a long running server-side process is necessary. The component can be run in
* 2 modes; "determinate" and "indeterminate".
*
* OutputProgress extends the JSF UIComponentBase class.
*
* By default this component is rendered by the "com.icesoft.faces.Bar" renderer
* type.
*/
public class OutputProgress extends UIComponentBase {
private final String DEFAULT_LABEL_POSITION = "embed";
private String label = null;
private String labelPosition = null;
private String labelComplete = null;
private String styleClass = null;
private boolean labelPositionChanged = false;
private String style = null;
private Integer value = null;
private Boolean indeterminate = null;
private String renderedOnUserRole;
/*
* (non-Javadoc)
*
* @see javax.faces.component.UIComponent#getFamily()
*/
public String getFamily() {
return "com.icesoft.faces.Progress";
}
/*
* (non-Javadoc)
*
* @see javax.faces.component.UIComponent#getRendererType()
*/
public String getRendererType() {
return "com.icesoft.faces.Bar";
}
/**
*
* Set the value of the label property.
*/
public void setLabel(String label) {
this.label = label;
}
/**
*
* Set the value of the labelPosition property.
*/
public void setLabelPosition(String labelPosition) {
this.labelPosition = labelPosition;
}
/**
*
* Set the value of the labelComplete property.
*/
public void setLabelComplete(String labelComplete) {
this.labelComplete = labelComplete;
}
public String getStyle() {
if (style != null) {
return style;
}
ValueBinding vb = getValueBinding("style");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
/**
*
* Set the value of the style property.
*/
public void setStyle(String style) {
this.style = style;
}
/**
*
* Set the value of the value property.
*/
public void setValue(int value) {
this.value = new Integer(value);
}
/**
*
* Return the value of the value property.
*/
public int getValue() {
if (value != null) {
return value.intValue();
}
ValueBinding vb = getValueBinding("value");
if (vb != null) {
Integer val = (Integer) vb.getValue(getFacesContext());
if (val != null) {
return val.intValue();
}
}
return 0;
}
/**
*
* Return the value of the label property.
*/
public String getLabel() {
if (label != null) {
return label;
}
ValueBinding vb = getValueBinding("label");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
public boolean isIndeterminate() {
if (indeterminate != null) {
return indeterminate.booleanValue();
}
ValueBinding vb = getValueBinding("indeterminate");
if (vb != null) {
return ((Boolean) vb.getValue(getFacesContext())).booleanValue();
}
return false;
}
/**
*
* Using isIndeterminate instead.
* @deprecated
*/
public boolean getIndeterminate() {
return isIndeterminate();
}
public void setIndeterminate(boolean b) {
indeterminate = new Boolean(b);
}
/**
*
* Return the value of the progressLabel property.
*/
public String getProgressLabel() {
if (getLabel() == null && getIndeterminate()) {
return "in progress...";
} else if (getLabel() != null) {
return DOMUtils.escapeAnsi(getLabel());
} else {
return getLabel();
}
}
/**
*
* Return the value of the labelPosition property.
*/
public String getLabelPosition() {
if (labelPosition != null) {
return labelPosition;
}
ValueBinding vb = getValueBinding("labelPosition");
return vb != null ? (String) vb.getValue(getFacesContext())
: DEFAULT_LABEL_POSITION;
}
/**
*
* Return the value of the labelComplete property.
*/
public String getLabelComplete() {
if (labelComplete != null) {
return labelComplete;
}
ValueBinding vb = getValueBinding("labelComplete");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
/**
*
* Return the value of the progressLabelComplete property.
*
*/
public String getProgressLabelComplete() {
if (getLabelComplete() == null && getIndeterminate()) {
return HTML.NBSP_ENTITY;
} else if (getLabelComplete() != null) {
return DOMUtils.escapeAnsi(getLabelComplete());
} else {
return getLabelComplete();
}
}
/**
*
* Set the value of the styleClass property.
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
*
* Return the value of the styleClass property.
*/
public String getStyleClass() {
return Util.getQualifiedStyleClass(this,
styleClass,
CSS_DEFAULT.OUTPUT_PROGRESS_BASE_CLASS,
"styleClass");
}
public String getTextClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.OUTPUT_PROGRESS_TEXT_STYLE_CLASS);
}
public String getBackgroundClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.OUTPUT_PROGRESS_BG_STYLE_CLASS);
}
public String getFillClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.OUTPUT_PROGRESS_FILL_STYLE_CLASS);
}
public String getIndeterminateActiveClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.OUTPUT_PROGRESS_INDETERMINATE_ACTIVE_CLASS);
}
public String getIndeterminateInactiveClass() {
return Util.getQualifiedStyleClass(this,
CSS_DEFAULT.OUTPUT_PROGRESS_INDETERMINATE_INACTIVE_CLASS);
}
/**
*
* Return the value of the rendered property.
*/
public boolean isRendered() {
if (!Util.isRenderedOnUserRole(this)) {
return false;
}
return super.isRendered();
}
/**
*
* Gets the state of the instance as a Serializable Object.
*
*/
public Object saveState(FacesContext context) {
Object values[] = new Object[10];
values[0] = super.saveState(context);
values[1] = label;
values[2] = labelPosition;
values[3] = labelComplete;
values[4] = new Boolean(labelPositionChanged);
values[5] = value;
values[6] = style;
values[7] = renderedOnUserRole;
values[8] = styleClass;
values[9] = indeterminate;
return ((Object) (values));
}
/**
*
* Perform any processing required to restore the state from the entries in
* the state Object.
*/
public void restoreState(FacesContext context, Object state) {
Object values[] = (Object[]) state;
super.restoreState(context, values[0]);
label = (String) values[1];
labelPosition = (String) values[2];
labelComplete = (String) values[3];
labelPositionChanged = ((Boolean) values[4]).booleanValue();
value = (Integer) values[5];
style = (String) values[6];
renderedOnUserRole = (String) values[7];
styleClass = (String) values[8];
indeterminate = (Boolean) values[9];
}
/**
* Set the value of the renderedOnUserRole property.
*/
public void setRenderedOnUserRole(String renderedOnUserRole) {
this.renderedOnUserRole = renderedOnUserRole;
}
/**
* Return the value of the renderedOnUserRole property.
*/
public String getRenderedOnUserRole() {
if (renderedOnUserRole != null) {
return renderedOnUserRole;
}
ValueBinding vb = getValueBinding("renderedOnUserRole");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
}