org.apache.myfaces.custom.schedule.AbstractHtmlSchedule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tomahawk Show documentation
JSF components and utilities that can be used with any JSF implementation. This library is compatible with both JSF1.1 and JSF1.2; however for JSF1.2 users there is an alternative build of Tomahawk available that takes advantage of JSF1.2 features to offer some additional benefits.
There is a newer version: 1.1.14
Show 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.Serializable;

import org.apache.myfaces.component.UserRoleAware;

/**
 * A schedule component similar to the ones found in Outlook or Evolution
 *  
 * Renders a schedule component, showing appointments and events
 * in a day, workweek, week or month view, similar to the schedule
 * part of MS Outlook or Evolution.
 * 

 * The component is backed by an implementation of the
 * ScheduleModel interface. Creating a custom model can be easily
 * achieved by implementing this interface, or by overriding
 * the AbstractScheduleModel class.
 * 

 * AbstractHtmlSchedule class holds all properties specific to the HTML version of the Schedule component.
 * 
 * 
 * @JSFComponent
 *   name = "t:schedule"
 *   class = "org.apache.myfaces.custom.schedule.HtmlSchedule"
 *   tagClass = "org.apache.myfaces.custom.schedule.ScheduleTag"
 *   tagHandler = "org.apache.myfaces.custom.schedule.ScheduleTagHandler"
 *   implements = "java.io.Serializable"
 *   serialuid = "5859593107442371656L"
 *
 * @author Bruno Aranda (latest modification by $Author: lu4242 $)
 * @author Jurgen Lust
 * @since 1.1.7
 * @version $Revision: 691856 $
 */
public abstract class AbstractHtmlSchedule extends UISchedule implements UserRoleAware,
        Serializable
{

    //private static final long serialVersionUID = 5859593107442371656L;
    
    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
    public static final String COMPONENT_TYPE = "org.apache.myfaces.Schedule";
    private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Schedule";

    /**
     * @JSFProperty
     * @return the backgroundClass
     */
    public abstract String getBackgroundClass();

    /**
     * @JSFProperty
     * @return the columnClass
     */
    public abstract String getColumnClass();

    /**
     * @JSFProperty
     * @return the contentClass
     */
    public abstract String getContentClass();

    /**
     * @JSFProperty
     * @return the dateClass
     */
    public abstract String getDateClass();

    /**
     * @JSFProperty
     * @return the dayClass
     */
    public abstract String getDayClass();

    /**
     * @JSFProperty
     * @return the entryClass
     */
    public abstract String getEntryClass();

    /**
     * @JSFProperty
     * @return the entryRenderer
     */
    public abstract Object getEntryRenderer();

    /**
     * @JSFProperty
     * @return the evenClass
     */
    public abstract String getEvenClass();

    /**
     * @JSFProperty
     * @return the foregroundClass
     */
    public abstract String getForegroundClass();

    /**
     * @JSFProperty
     * @return the freeClass
     */
    public abstract String getFreeClass();

    /**
     * @JSFProperty
     * @return the gutterClass
     */
    public abstract String getGutterClass();

    /**
     * @JSFProperty
     * @return the headerClass
     */
    public abstract String getHeaderClass();

    /**
     * @JSFProperty
     * @return the holidayClass
     */
    public abstract String getHolidayClass();

    /**
     * @JSFProperty
     * @return the hoursClass
     */
    public abstract String getHoursClass();

    /**
     * @JSFProperty
     * @return the inactiveDayClass
     */
    public abstract String getInactiveDayClass();

    /**
     * @JSFProperty
     * @return the minutesClass
     */
    public abstract String getMinutesClass();

    /**
     * @JSFProperty
     * @return the monthClass
     */
    public abstract String getMonthClass();

    /**
     * @JSFProperty
     * @return the selectedClass
     */
    public abstract String getSelectedClass();

    /**
     * @JSFProperty
     * @return the selectedEntryClass
     */
    public abstract String getSelectedEntryClass();

    /**
     * @JSFProperty
     * @return the subtitleClass
     */
    public abstract String getSubtitleClass();

    /**
     * @JSFProperty
     * @return the textClass
     */
    public abstract String getTextClass();

    /**
     * @JSFProperty
     * @return the titleClass
     */
    public abstract String getTitleClass();

    /**
     * @JSFProperty
     * @return the unevenClass
     */
    public abstract String getUnevenClass();

    /**
     * the css class of the table representing a week in the compact mode (default: week)
     * 
     * @JSFProperty
     * @return the weekClass
     */
    public abstract String getWeekClass();

}
//The End