org.primefaces.component.layout.Layout Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.component.layout;
import java.util.Collection;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.application.ResourceDependencies;
import javax.faces.application.ResourceDependency;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.event.AjaxBehaviorEvent;
import javax.faces.event.BehaviorEvent;
import javax.faces.event.FacesEvent;
import org.primefaces.event.CloseEvent;
import org.primefaces.event.ResizeEvent;
import org.primefaces.event.ToggleEvent;
import org.primefaces.model.Visibility;
import org.primefaces.util.Constants;
import org.primefaces.util.MapBuilder;
@ResourceDependencies({
@ResourceDependency(library = "primefaces", name = "components.css"),
@ResourceDependency(library = "primefaces", name = "layout/layout.css"),
@ResourceDependency(library = "primefaces", name = "jquery/jquery.js"),
@ResourceDependency(library = "primefaces", name = "jquery/jquery-plugins.js"),
@ResourceDependency(library = "primefaces", name = "core.js"),
@ResourceDependency(library = "primefaces", name = "components.js"),
@ResourceDependency(library = "primefaces", name = "layout/layout.js")
})
public class Layout extends LayoutBase {
public static final String COMPONENT_TYPE = "org.primefaces.component.Layout";
public static final String UNIT_CLASS = "ui-layout-unit ui-widget ui-widget-content ui-corner-all";
public static final String UNIT_HEADER_CLASS = "ui-layout-unit-header ui-widget-header ui-corner-all";
public static final String UNIT_CONTENT_CLASS = "ui-layout-unit-content ui-widget-content";
public static final String UNIT_FOOTER_CLASS = "ui-layout-unit-footer ui-widget-header ui-corner-all";
public static final String UNIT_HEADER_TITLE_CLASS = "ui-layout-unit-header-title";
public static final String UNIT_FOOTER_TITLE_CLASS = "ui-layout-unit-footer-title";
public static final String UNIT_HEADER_ICON_CLASS = "ui-layout-unit-header-icon ui-state-default ui-corner-all";
private static final Map> BEHAVIOR_EVENT_MAPPING = MapBuilder.>builder()
.put("close", CloseEvent.class)
.put("resize", ResizeEvent.class)
.build();
private static final Collection EVENT_NAMES = BEHAVIOR_EVENT_MAPPING.keySet();
@Override
public Map> getBehaviorEventMapping() {
return BEHAVIOR_EVENT_MAPPING;
}
@Override
public Collection getEventNames() {
return EVENT_NAMES;
}
protected LayoutUnit getLayoutUnitByPosition(String name) {
for (UIComponent child : getChildren()) {
if (child instanceof LayoutUnit) {
LayoutUnit layoutUnit = (LayoutUnit) child;
if (layoutUnit.getPosition().equalsIgnoreCase(name)) {
return layoutUnit;
}
}
}
return null;
}
public boolean isNested() {
return getParent() instanceof LayoutUnit;
}
public boolean isElementLayout() {
return !isNested() && !isFullPage();
}
@Override
public void processDecodes(FacesContext context) {
if (isSelfRequest(context)) {
decode(context);
}
else {
super.processDecodes(context);
}
}
@Override
public void processValidators(FacesContext context) {
if (!isSelfRequest(context)) {
super.processValidators(context);
}
}
@Override
public void processUpdates(FacesContext context) {
if (!isSelfRequest(context)) {
super.processUpdates(context);
}
}
private boolean isSelfRequest(FacesContext context) {
return getClientId(context).equals(context.getExternalContext().getRequestParameterMap().get(Constants.RequestParams.PARTIAL_SOURCE_PARAM));
}
@Override
public void queueEvent(FacesEvent event) {
FacesContext context = getFacesContext();
Map params = context.getExternalContext().getRequestParameterMap();
String eventName = params.get(Constants.RequestParams.PARTIAL_BEHAVIOR_EVENT_PARAM);
String clientId = getClientId(context);
if (isSelfRequest(context)) {
AjaxBehaviorEvent behaviorEvent = (AjaxBehaviorEvent) event;
FacesEvent wrapperEvent = null;
if (eventName.equals("toggle")) {
boolean collapsed = Boolean.parseBoolean(params.get(clientId + "_collapsed"));
LayoutUnit unit = getLayoutUnitByPosition(params.get(clientId + "_unit"));
Visibility visibility = collapsed ? Visibility.HIDDEN : Visibility.VISIBLE;
unit.setCollapsed(collapsed);
wrapperEvent = new ToggleEvent(unit, behaviorEvent.getBehavior(), visibility);
}
else if (eventName.equals("close")) {
LayoutUnit unit = getLayoutUnitByPosition(params.get(clientId + "_unit"));
unit.setVisible(false);
wrapperEvent = new CloseEvent(unit, behaviorEvent.getBehavior());
}
else if (eventName.equals("resize")) {
LayoutUnit unit = getLayoutUnitByPosition(params.get(clientId + "_unit"));
String position = unit.getPosition();
int width = Integer.parseInt(params.get(clientId + "_width"));
int height = Integer.parseInt(params.get(clientId + "_height"));
if (position.equals("west") || position.equals("east")) {
unit.setSize(String.valueOf(width));
}
else if (position.equals("north") || position.equals("south")) {
unit.setSize(String.valueOf(height));
}
wrapperEvent = new ResizeEvent(unit, behaviorEvent.getBehavior(), width, height);
}
if (wrapperEvent == null) {
throw new FacesException("Component " + this.getClass().getName() + " does not support event " + eventName + "!");
}
wrapperEvent.setPhaseId(behaviorEvent.getPhaseId());
super.queueEvent(wrapperEvent);
}
else {
super.queueEvent(event);
}
}
}