org.fujion.highcharts.DateTimeFormatOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-highcharts Show documentation
There is a newer version: 3.1.0
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2008 - 2016 Regenstrief Institute, Inc.
 * %%
 * 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.
 *
 * #L%
 */
package org.fujion.highcharts;

import org.fujion.ancillary.Options;

/**
 * For a date/time axis, the scale will automatically adjust to the appropriate unit. This class
 * gives the default string representations used for each unit.
 *
 *  * Supported format specifiers are:
 * 
 * %a: Short weekday, like 'Mon'.
 * %A: Long weekday, like 'Monday'.
 * %d: Two digit day of the month, 01 to 31.
 * %e: Day of the month, 1 through 31.
 * %b: Short month, like 'Jan'.
 * %B: Long month, like 'January'.
 * %m: Two digit month number, 01 through 12.
 * %y: Two digits year, like 09 for 2009.
 * %Y: Four digits year, like 2009.
 * %H: Two digits hours in 24h format, 00 through 23.
 * %I: Two digits hours in 12h format, 00 through 11.
 * %l  Hours in 12h format, 1 through 11. (Lower case L)
 * %M: Two digits minutes, 00 through 59.
 * %p: Upper case AM or PM.
 * %P: Lower case AM or PM.
 * %S: Two digits seconds, 00 through 59
 *
 * 
 */
public class DateTimeFormatOptions extends Options {
    
    /**
     * Axis defaults: "%H:%M:%S.%L" 

     * Tooltip defaults: "%A, %b %e, %H:%M:%S.%L"
     */
    public String millisecond;
    
    /**
     * Axis defaults: "%H:%M:%S" 

     * Tooltip defaults: "%A, %b %e, %H:%M:%S"
     */
    public String second;
    
    /**
     * Axis defaults: "%H:%M" 

     * Tooltip defaults: "%A, %b %e, %H:%M"
     */
    public String minute;
    
    /**
     * Axis defaults: "%H:%M" 

     * Tooltip defaults: "%A, %b %e, %H:%M"
     */
    public String hour;
    
    /**
     * Axis defaults: "%e. %b" 

     * Tooltip defaults: "%A, %b %e, %Y"
     */
    public String day;
    
    /**
     * Axis defaults: "%e. %b" 

     * Tooltip defaults: "Week from %A, %b %e, %Y"
     */
    public String week;
    
    /**
     * Axis defaults: "%b \'%y" 

     * Tooltip defaults: "%B %Y"
     */
    public String month;
    
    /**
     * Axis defaults: "%Y" 

     * Tooltip defaults: "%Y"
     */
    public String year;
    
    /**
     * Sets all formats to the specified value.
     *
     * @param value Format value.
     */
    public void setAllFormats(String value) {
        setDateFormats(value);
        setTimeFormats(value);
    }
    
    /**
     * Sets all date formats to specified value.
     *
     * @param value Date format value.
     */
    public void setDateFormats(String value) {
        day = value;
        month = value;
        week = value;
        year = value;
    }
    
    /**
     * Sets all time formats to specified value.
     *
     * @param value Time format value.
     */
    public void setTimeFormats(String value) {
        hour = value;
        millisecond = value;
        minute = value;
        second = value;
    }
    
}