org.apache.myfaces.custom.schedule.AbstractCompactScheduleRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tomahawk21 Show documentation
Show all versions of tomahawk21 Show documentation
JSF components and utilities that can be used with any JSF implementation.
This library is based on the JSF1.1 version of Tomahawk, but with minor source code and build
changes to take advantage of JSF2.1 features. A JSF2.1 implementation is required to use this
version of the Tomahawk library.
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.myfaces.custom.schedule;
import java.io.IOException;
import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
import java.util.Iterator;
import java.util.TreeSet;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.myfaces.custom.schedule.model.ScheduleDay;
import org.apache.myfaces.custom.schedule.model.ScheduleEntry;
import org.apache.myfaces.custom.schedule.util.ScheduleUtil;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
import org.apache.myfaces.shared_tomahawk.renderkit.html.util.FormInfo;
/**
*
* Abstract superclass for the week and month view renderers.
*
*
* @since 1.1.7
* @author Jurgen Lust (latest modification by $Author: jlust $)
* @author Bruno Aranda (adaptation of Jurgen's code to myfaces)
* @version $Revision: 398348 $
*/
public abstract class AbstractCompactScheduleRenderer extends
AbstractScheduleRenderer implements Serializable
{
private static final Log log = LogFactory.getLog(AbstractCompactScheduleRenderer.class);
// ~ Methods
// ----------------------------------------------------------------
/**
* @see javax.faces.render.Renderer#encodeChildren(javax.faces.context.FacesContext,
* javax.faces.component.UIComponent)
*/
public void encodeChildren(FacesContext context, UIComponent component)
throws IOException
{
// the children are rendered in the encodeBegin phase
}
/**
* @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext,
* javax.faces.component.UIComponent)
*/
public void encodeEnd(FacesContext context, UIComponent component)
throws IOException
{
// all rendering is done in the begin phase
}
/**
* @return The default height, in pixels, of one row in the schedule grid
*/
protected abstract int getDefaultRowHeight();
/**
*
* Draw one day in the schedule
*
*
* @param context
* the FacesContext
* @param writer
* the ResponseWriter
* @param schedule
* the schedule
* @param day
* the day that should be drawn
* @param cellWidth
* the width of the cell
* @param dayOfWeek
* the day of the week
* @param dayOfMonth
* the day of the month
* @param isWeekend
* is it a weekend day?
* @param isCurrentMonth
* is the day in the currently selected month?
* @param rowspan
* the rowspan for the table cell
*
* @throws IOException
* when the cell could not be drawn
*/
protected void writeDayCell(FacesContext context, ResponseWriter writer,
HtmlSchedule schedule, ScheduleDay day, float cellWidth,
int dayOfWeek, int dayOfMonth, boolean isWeekend,
boolean isCurrentMonth, int rowspan) throws IOException
{
final String clientId = schedule.getClientId(context);
final FormInfo parentFormInfo = RendererUtils.findNestingForm(schedule, context);
final String formId = parentFormInfo == null ? null : parentFormInfo.getFormName();
final String dayHeaderId = clientId + "_header_" + ScheduleUtil.getDateId(day.getDate(), schedule.getModel().getTimeZone());
final String dayBodyId = clientId + "_body_" + ScheduleUtil.getDateId(day.getDate(), schedule.getModel().getTimeZone());
writer.startElement(HTML.TD_ELEM, schedule);
writer.writeAttribute("rowspan", String.valueOf(rowspan), null);
boolean isToday = ScheduleUtil.isSameDay(day.getDate(), new Date(), schedule.getModel().getTimeZone());
String dayClass = getStyleClass(schedule, isCurrentMonth ? "day" : "inactive-day") +
" " + getStyleClass(schedule, isWeekend ? "weekend" : "workday") + " " + (isToday ? getStyleClass(schedule, "today") : "");
writer.writeAttribute(HTML.CLASS_ATTR, dayClass, null);
// determine the height of the day in pixels
StringBuffer styleBuffer = new StringBuffer();
int rowHeight = getRowHeight(schedule);
String myRowHeight = "height: ";
String myContentHeight = "height: ";
if (rowHeight > 0)
{
if (isWeekend && schedule.isSplitWeekend())
{
myRowHeight += (rowHeight / 2) + "px;";
myContentHeight += ((rowHeight / 2) - 19) + "px;";
}
else
{
myRowHeight += (rowHeight + (schedule.isSplitWeekend() ? 1 : 0)) + "px;"; //need to add 1 to get the weekends right
myContentHeight += ((rowHeight + (schedule.isSplitWeekend() ? 1 : 0)) - 18) + "px;"; //18 instead of 19, to get the weekends right
}
}
else
{
myRowHeight += "100%;";
myContentHeight += "100%;";
}
styleBuffer.append(myRowHeight);
styleBuffer.append("width: " + cellWidth + "%;");
styleBuffer.append("vertical-align: top;");
writer.writeAttribute(HTML.STYLE_ATTR, styleBuffer.toString(), null);
writer.startElement(HTML.DIV_ELEM, schedule);
writer.writeAttribute(HTML.CLASS_ATTR, getStyleClass(schedule, "day"),
null);
// day header
writer.startElement(HTML.DIV_ELEM, schedule);
writer.writeAttribute(HTML.CLASS_ATTR,
getStyleClass(schedule, "header"), null);
writer.writeAttribute(HTML.STYLE_ATTR,
"height: 18px; overflow: hidden", null);
writer.startElement(HTML.ANCHOR_ELEM, schedule);
writer.writeAttribute(HTML.ID_ATTR, dayHeaderId, null);
writer.writeAttribute(HTML.HREF_ATTR, "#", null);
//register an onclick event listener to a day header which will capture
//the date
if (!schedule.isReadonly() && schedule.isSubmitOnClick()) {
writer.writeAttribute(
HTML.ONCLICK_ATTR,
"fireScheduleDateClicked(this, event, '"
+ formId + "', '"
+ clientId
+ "');",
null);
}
writer.writeText(getDateString(context, schedule, day.getDate()), null);
writer.endElement(HTML.ANCHOR_ELEM);
writer.endElement(HTML.DIV_ELEM);
// day content
writer.startElement(HTML.DIV_ELEM, schedule);
writer.writeAttribute(HTML.CLASS_ATTR, getStyleClass(schedule,
"content"), null);
// determine the height of the day content in pixels
writer.writeAttribute(HTML.STYLE_ATTR, myContentHeight + " overflow: auto; vertical-align: top;", null);
//this extra div is required, because when a scrollbar is visible and
//it is clicked, the fireScheduleTimeClicked() method is fired.
writer.startElement(HTML.DIV_ELEM, schedule);
writer
.writeAttribute(
HTML.STYLE_ATTR,
"height: 100%; vertical-align: top;",
null);
writer.writeAttribute(HTML.ID_ATTR, dayBodyId, null);
//register an onclick event listener to a day cell which will capture
//the date
if (!schedule.isReadonly() && schedule.isSubmitOnClick()) {
writer.writeAttribute(
HTML.ONCLICK_ATTR,
"fireScheduleTimeClicked(this, event, '"
+ formId + "', '"
+ clientId
+ "');",
null);
}
writeEntries(context, schedule, day, writer);
writer.endElement(HTML.DIV_ELEM);
writer.endElement(HTML.DIV_ELEM);
writer.endElement(HTML.DIV_ELEM);
writer.endElement(HTML.TD_ELEM);
}
/**
*
* Draw the schedule entries in the specified day cell
*
*
* @param context
* the FacesContext
* @param schedule
* the schedule
* @param day
* the day
* @param writer
* the ResponseWriter
*
* @throws IOException
* when the entries could not be drawn
*/
protected void writeEntries(FacesContext context, HtmlSchedule schedule,
ScheduleDay day, ResponseWriter writer) throws IOException
{
final String clientId = schedule.getClientId(context);
final FormInfo parentFormInfo = RendererUtils.findNestingForm(schedule, context);
final String formId = parentFormInfo == null ? null : parentFormInfo.getFormName();
final TreeSet entrySet = new TreeSet(comparator);
for (Iterator entryIterator = day.iterator(); entryIterator.hasNext();)
{
ScheduleEntry entry = (ScheduleEntry) entryIterator.next();
entrySet.add(entry);
}
if (entrySet.size() > 0)
{
writer.startElement(HTML.TABLE_ELEM, schedule);
writer.writeAttribute(HTML.CELLPADDING_ATTR, "0", null);
writer.writeAttribute(HTML.CELLSPACING_ATTR, "0", null);
writer.writeAttribute(HTML.STYLE_ATTR, "width: 100%;", null);
for (Iterator entryIterator = entrySet.iterator(); entryIterator
.hasNext();)
{
ScheduleEntry entry = (ScheduleEntry) entryIterator.next();
writer.startElement(HTML.TR_ELEM, schedule);
writer.startElement(HTML.TD_ELEM, schedule);
if (isSelected(schedule, entry))
{
writer.writeAttribute(HTML.CLASS_ATTR, getStyleClass(schedule,
"selected"), null);
}
//compose the CSS style for the entry box
StringBuffer entryStyle = new StringBuffer();
entryStyle.append("width: 100%;");
String entryColor = getEntryRenderer(schedule).getColor(context, schedule, entry, isSelected(schedule, entry));
if (isSelected(schedule, entry) && entryColor != null) {
entryStyle.append(" background-color: ");
entryStyle.append(entryColor);
entryStyle.append(";");
entryStyle.append(" border-color: ");
entryStyle.append(entryColor);
entryStyle.append(";");
}
writer.writeAttribute(HTML.STYLE_ATTR, entryStyle.toString(), null);
// draw the tooltip
if (schedule.isTooltip())
{
getEntryRenderer(schedule).renderToolTip(context, writer,
schedule, entry, isSelected(schedule, entry));
}
if (!isSelected(schedule, entry) && !schedule.isReadonly())
{
writer.startElement(HTML.ANCHOR_ELEM, schedule);
writer.writeAttribute(HTML.HREF_ATTR, "#", null);
writer.writeAttribute(
HTML.ONCLICK_ATTR,
"fireEntrySelected('"
+ formId + "', '"
+ clientId + "', '"
+ entry.getId()
+ "');",
null);
}
// draw the content
getEntryRenderer(schedule).renderContent(context, writer, schedule,
day, entry, true, isSelected(schedule, entry));
if (!isSelected(schedule, entry) && !schedule.isReadonly())
{
writer.endElement(HTML.ANCHOR_ELEM);
}
writer.endElement(HTML.TD_ELEM);
writer.endElement(HTML.TR_ELEM);
}
writer.endElement(HTML.TABLE_ELEM);
}
}
protected boolean isSelected(HtmlSchedule schedule, ScheduleEntry entry)
{
ScheduleEntry selectedEntry = schedule.getModel().getSelectedEntry();
if (selectedEntry == null)
{
return false;
}
return selectedEntry.getId().equals(entry.getId());
}
/**
* In the compact renderer, we don't take the y coordinate of the mouse
* into account when determining the last clicked date.
*/
protected Date determineLastClickedDate(HtmlSchedule schedule, String dateId, String yPos) {
//the dateId is the schedule client id + "_" + yyyyMMdd
String day = dateId.substring(dateId.lastIndexOf("_") + 1);
Date date = ScheduleUtil.getDateFromId(day, schedule.getModel().getTimeZone());
Calendar cal = getCalendarInstance(schedule, date != null ? date : new Date());
cal.set(Calendar.HOUR_OF_DAY, schedule.getVisibleStartHour());
cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MILLISECOND, 0);
log.debug("last clicked datetime: " + cal.getTime());
return cal.getTime();
}
}
// The End