org.primefaces.extensions.component.keynote.KeynoteRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces-extensions Show documentation
Show all versions of primefaces-extensions Show documentation
PrimeFaces Extensions components and utilities for PrimeFaces.
/*
* Copyright (c) 2011-2024 PrimeFaces Extensions
*
* 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.extensions.component.keynote;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import javax.faces.FacesException;
import javax.faces.application.Resource;
import javax.faces.component.UIComponent;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.primefaces.extensions.model.keynote.KeynoteItem;
import org.primefaces.extensions.util.Attrs;
import org.primefaces.renderkit.CoreRenderer;
import org.primefaces.util.WidgetBuilder;
public class KeynoteRenderer extends CoreRenderer {
public static final String CONTAINER_CLASS = "ui-keynote reveal";
public static final String SLIDES_CLASS = "slides";
/**
* {@inheritDoc}
*/
@Override
public void decode(final FacesContext context, final UIComponent component) {
decodeBehaviors(context, component);
}
/**
* {@inheritDoc}
*/
@Override
public void encodeBegin(final FacesContext context, final UIComponent component) throws IOException {
final Keynote keynote = (Keynote) component;
if (!"none".equals(keynote.getTheme())) {
encodeCSS(context, keynote.getLibrary(), keynote.getTheme());
}
}
/**
* {@inheritDoc}
*/
@Override
public void encodeEnd(final FacesContext context, final UIComponent component) throws IOException {
final Keynote keynote = (Keynote) component;
encodeMarkup(context, keynote);
encodeScript(context, keynote);
}
/**
* Create the HTML markup for the DOM.
*/
private void encodeMarkup(final FacesContext context, final Keynote keynote) throws IOException {
final ResponseWriter writer = context.getResponseWriter();
final String clientId = keynote.getClientId(context);
final String styleClass = getStyleClassBuilder(context)
.add(CONTAINER_CLASS)
.add(keynote.getStyleClass())
.build();
writer.startElement("div", keynote);
writer.writeAttribute("id", clientId, null);
writer.writeAttribute(Attrs.CLASS, styleClass, "styleClass");
if (keynote.getStyle() != null) {
writer.writeAttribute(Attrs.STYLE, keynote.getStyle(), Attrs.STYLE);
}
writer.startElement("div", null);
writer.writeAttribute(Attrs.CLASS, SLIDES_CLASS, "class");
if (keynote.getVar() != null) {
// dynamic items
final Object value = keynote.getValue();
if (value != null) {
if (!(value instanceof Collection)) {
throw new FacesException("Value in Keynote must be of type Collection / List");
}
final List children = keynote.getChildren();
for (int i = 0; i < children.size(); i++) {
final UIComponent kid = children.get(i);
if (kid.isRendered() && !(kid instanceof UIKeynoteItem)) {
// first render children like stamped elements, etc.
renderChild(context, kid);
}
}
final Collection col = (Collection) value;
for (int i = 0; i < col.size(); i++) {
final KeynoteItem keynoteItem = (KeynoteItem) col.toArray()[i];
// find ui item by type
final UIKeynoteItem uiItem = keynote.getItem(keynoteItem.getType());
if (uiItem.isRendered()) {
// set data in request scope
keynote.setData(keynoteItem);
// render item
renderChild(context, uiItem);
}
}
}
}
else {
// static items
final List children = keynote.getChildren();
for (int i = 0; i < children.size(); i++) {
final UIComponent kid = children.get(i);
if (kid.isRendered()) {
renderChild(context, kid);
}
}
}
writer.endElement("div");
writer.endElement("div");
}
/**
* Create the Javascript.
*/
private void encodeScript(final FacesContext context, final Keynote keynote) throws IOException {
final WidgetBuilder wb = getWidgetBuilder(context);
wb.init("ExtKeynote", keynote)
.attr("width", keynote.getWidth(), 960)
.attr("height", keynote.getHeight(), 700)
.attr("margin", keynote.getMargin(), 0.04)
.attr("minScale", keynote.getMinScale(), 0.2)
.attr("maxScale", keynote.getMaxScale(), 2.0)
.attr("autoSlide", keynote.getAutoSlide(), 0)
.attr("center", keynote.isCenter(), true)
.attr("controls", keynote.isControls(), true)
.attr("disableLayout", keynote.isDisableLayout(), false)
.attr("embedded", keynote.isEmbedded(), false)
.attr("loop", keynote.isLoop(), false)
.attr("navigationMode", keynote.getNavigationMode(), "default")
.attr("progress", keynote.isProgress(), true)
.attr("showNotes", keynote.isShowNotes(), false)
.attr("slideNumber", keynote.getSlideNumber(), "false")
.attr("touch", keynote.isTouch(), true)
.attr("transition", keynote.getTransition(), "slide")
.attr("transitionSpeed", keynote.getTransitionSpeed(), "default")
.attr("backgroundTransition", keynote.getBackgroundTransition(), "fade")
.attr("theme", keynote.getTheme(), "none");
encodeClientBehaviors(context, keynote);
wb.finish();
}
private void encodeCSS(final FacesContext context, final String library, final String theme) throws IOException {
final ResponseWriter writer = context.getResponseWriter();
final ExternalContext externalContext = context.getExternalContext();
final Resource cssResource = context.getApplication()
.getResourceHandler()
.createResource("keynote/theme/" + theme + ".css", library);
if (cssResource == null) {
throw new FacesException(
"Error loading CSS, cannot find \"" + theme + "\" resource of \"" + library + "\" library");
}
else {
writer.startElement("link", null);
writer.writeAttribute("type", "text/css", null);
writer.writeAttribute("rel", "stylesheet", null);
writer.writeAttribute("href", externalContext.encodeResourceURL(cssResource.getRequestPath()), null);
writer.endElement("link");
}
}
/**
* {@inheritDoc}
*/
@Override
public void encodeChildren(final FacesContext context, final UIComponent component) {
// Do nothing
}
/**
* {@inheritDoc}
*/
@Override
public boolean getRendersChildren() {
return true;
}
}