com.citytechinc.cq.component.annotations.widgets.DateField Maven / Gradle / Ivy
/**
* Copyright 2017 ICF Olson
*
* 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.
*/
package com.citytechinc.cq.component.annotations.widgets;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Represents a Widget of type CQ.Ext.form.DateField in Classic UI
*
* Represents a Widget of type granite/ui/components/foundation/form/datepicker
* in Touch UI
*/
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface DateField {
/**
* Used for Classic UI only
*
* Day index at which the week should begin, 0-based
*
* @return int
*/
int startDay() default 0;
/**
* Used for Classic UI only
*
* false to hide the footer area of the DatePicker containing the Today
* button and disable the keyboard handler for spacebar that selects the
* current date
*
* @return boolean
*/
boolean showToday() default true;
/**
* Used for Classic UI only
*
* The default date format string which can be overriden for localization
* support. The format must be valid according to Date.parseDate
*
* @return String
*/
String format() default "m/d/Y";
/**
* For Touch-UI only
*
* Similar to format but uses a different standard for specifying date
* formats.
*
* @return String
*/
String storedFormat() default "YYYY-MM-DD[T]HH:mm:ss.000Z";
/**
* For Touch-UI only
*
* Display format for the date selected
*
* @return String
*/
String displayedFormat() default "MM/DD/YYYY";
/**
* For Touch-UI only
*
* The minimum selectable date
*
* @return String
*/
String minDate() default "";
/**
* For Touch-UI only
*
* The maximum selectable date
*
* @return String
*/
String maxDate() default "";
}