CmsJspInstanceDateBean.CmsDateFormatOption (OpenCms Core API, version 17.0)

java.lang.Object
- org.opencms.jsp.util.CmsJspInstanceDateBean.CmsDateFormatOption

Enclosing class:: CmsJspInstanceDateBean

public static class CmsJspInstanceDateBean.CmsDateFormatOption
extends java.lang.Object

Formatting options for dates.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  CmsDateFormatOption(java.lang.String configString, java.util.Locale locale)
  Create a new date format option.
- Method Summary
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CmsDateFormatOption
```
public CmsDateFormatOption(java.lang.String configString,
                           java.util.Locale locale)
                    throws java.lang.IllegalArgumentException
```
    Create a new date format option. Examples (for date 19/06/82 11:17):
    
    "dd/MM/yy"
    
    formatDate: "19/06/82"
    
    formatTime: ""
    
    formatDateTime: "19/06/82"
    
    "dd/MM/yy|hh:mm"
    
    formatDate: "19/06/82"
    
    formatTime: "11:17"
    
    formatDateTime: "19/06/82 11:17"
    
    "dd/MM/yy|hh:mm|dd/MM/yy - hh:mm"
    
    formatDate: "19/06/82"
    
    formatTime: "11:17"
    
    formatDateTime: "19/06/82 - 11:17"
    Parameters:
    
    configString - the configuration string, should be structured as "datePattern|timePattern|dateTimePattern", where only datePattern is mandatory.
    
    locale - the locale to use for printing days of week, month names etc.
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if the configured patterns are invalid.