net.bootsfaces.component.jumbotron.Jumbotron Maven / Gradle / Ivy
/**
* Copyright 2014-2019 Riccardo Massera (TheCoder4.Eu) and Stephan Rauh (http://www.beyondjava.net).
*
* This file is part of BootsFaces.
*
* 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 net.bootsfaces.component.jumbotron;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.AbortProcessingException;
import jakarta.faces.event.ComponentSystemEvent;
import jakarta.faces.event.ListenerFor;
import jakarta.faces.event.ListenersFor;
import jakarta.faces.event.PostAddToViewEvent;
import jakarta.el.ValueExpression;
import jakarta.faces.component.FacesComponent;
import jakarta.faces.component.UIOutput;
import net.bootsfaces.C;
import net.bootsfaces.listeners.AddResourcesListener;
import net.bootsfaces.render.IContentDisabled;
import net.bootsfaces.render.Tooltip;
import net.bootsfaces.utils.BsfUtils;
/** This class holds the attributes of <b:jumbotron />. */
@ListenersFor({ @ListenerFor(systemEventClass = PostAddToViewEvent.class) })
@FacesComponent(Jumbotron.COMPONENT_TYPE)
public class Jumbotron extends UIOutput implements net.bootsfaces.render.IHasTooltip, IContentDisabled {
public static final String COMPONENT_TYPE = C.BSFCOMPONENT + ".jumbotron.Jumbotron";
public static final String COMPONENT_FAMILY = C.BSFCOMPONENT;
public static final String DEFAULT_RENDERER = "net.bootsfaces.component.jumbotron.Jumbotron";
public Jumbotron() {
Tooltip.addResourceFiles();
AddResourcesListener.addThemedCSSResource("core.css");
//!bs-less//AddResourcesListener.addThemedCSSResource("jumbotron.css");
setRendererType(DEFAULT_RENDERER);
}
public String getFamily() {
return COMPONENT_FAMILY;
}
public void setValueExpression(String name, ValueExpression binding) {
name = BsfUtils.snakeCaseToCamelCase(name);
super.setValueExpression(name, binding);
}
public void processEvent(ComponentSystemEvent event) throws AbortProcessingException {
if (isAutoUpdate()) {
if (FacesContext.getCurrentInstance().isPostback()) {
FacesContext.getCurrentInstance().getPartialViewContext().getRenderIds().add(getClientId());
}
super.processEvent(event);
}
}
protected enum PropertyKeys {
autoUpdate, contentDisabled, style, styleClass, tooltip, tooltipContainer, tooltipDelay, tooltipDelayHide, tooltipDelayShow, tooltipPosition;
String toString;
PropertyKeys(String toString) {
this.toString = toString;
}
PropertyKeys() {
}
public String toString() {
return ((this.toString != null) ? this.toString : super.toString());
}
}
/**
* Setting this flag updates the widget on every AJAX request.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isAutoUpdate() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.autoUpdate, false);
}
/**
* Setting this flag updates the widget on every AJAX request.
* Usually this method is called internally by the JSF engine.
*/
public void setAutoUpdate(boolean _autoUpdate) {
getStateHelper().put(PropertyKeys.autoUpdate, _autoUpdate);
}
/**
* Enables or disables every child element of this container. By default, child elements are enabled.
* @return Returns the value of the attribute, or false, if it hasn't been set by the JSF file.
*/
public boolean isContentDisabled() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.contentDisabled, false);
}
/**
* Enables or disables every child element of this container. By default, child elements are enabled.
* Usually this method is called internally by the JSF engine.
*/
public void setContentDisabled(boolean _contentDisabled) {
getStateHelper().put(PropertyKeys.contentDisabled, _contentDisabled);
}
/**
* Inline style of the input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getStyle() {
return (String) getStateHelper().eval(PropertyKeys.style);
}
/**
* Inline style of the input element.
* Usually this method is called internally by the JSF engine.
*/
public void setStyle(String _style) {
getStateHelper().put(PropertyKeys.style, _style);
}
/**
* Style class of this element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getStyleClass() {
return (String) getStateHelper().eval(PropertyKeys.styleClass);
}
/**
* Style class of this element.
* Usually this method is called internally by the JSF engine.
*/
public void setStyleClass(String _styleClass) {
getStateHelper().put(PropertyKeys.styleClass, _styleClass);
}
/**
* The text of the tooltip.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getTooltip() {
return (String) getStateHelper().eval(PropertyKeys.tooltip);
}
/**
* The text of the tooltip.
* Usually this method is called internally by the JSF engine.
*/
public void setTooltip(String _tooltip) {
getStateHelper().put(PropertyKeys.tooltip, _tooltip);
}
/**
* Where is the tooltip div generated? That's primarily a technical value that can be used to fix rendering errors in special cases. Also see data-container in the documentation of Bootstrap. The default value is body.
* @return Returns the value of the attribute, or "body", if it hasn't been set by the JSF file.
*/
public String getTooltipContainer() {
return (String) getStateHelper().eval(PropertyKeys.tooltipContainer, "body");
}
/**
* Where is the tooltip div generated? That's primarily a technical value that can be used to fix rendering errors in special cases. Also see data-container in the documentation of Bootstrap. The default value is body.
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipContainer(String _tooltipContainer) {
getStateHelper().put(PropertyKeys.tooltipContainer, _tooltipContainer);
}
/**
* The tooltip is shown and hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelay() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelay, 0);
}
/**
* The tooltip is shown and hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelay(int _tooltipDelay) {
getStateHelper().put(PropertyKeys.tooltipDelay, _tooltipDelay);
}
/**
* The tooltip is hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelayHide() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelayHide, 0);
}
/**
* The tooltip is hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelayHide(int _tooltipDelayHide) {
getStateHelper().put(PropertyKeys.tooltipDelayHide, _tooltipDelayHide);
}
/**
* The tooltip is shown with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelayShow() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelayShow, 0);
}
/**
* The tooltip is shown with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelayShow(int _tooltipDelayShow) {
getStateHelper().put(PropertyKeys.tooltipDelayShow, _tooltipDelayShow);
}
/**
* Where is the tooltip to be displayed? Possible values: "top", "bottom", "right", "left", "auto", "auto top", "auto bottom", "auto right" and "auto left". Default to "bottom".
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getTooltipPosition() {
return (String) getStateHelper().eval(PropertyKeys.tooltipPosition);
}
/**
* Where is the tooltip to be displayed? Possible values: "top", "bottom", "right", "left", "auto", "auto top", "auto bottom", "auto right" and "auto left". Default to "bottom".
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipPosition(String _tooltipPosition) {
getStateHelper().put(PropertyKeys.tooltipPosition, _tooltipPosition);
}
}