Outline of an owl uiloos

DateGalleryDate<T>

CLASS

Represents a date inside of one of the DateGallery frames.

A DateGalleryDate knows whether it has been selected or not, whether it is a padded date, which DateGalleryEvent lie on the date etc etc.

You should never instantiate a DateGalleryDate directly instead the DateGallery should provide them to you.

Since 1.6.0

Constructor

Creates an DateGalleryDate which belongs to the given DateGallery.

Note: you should never create instances of DateGalleryDate yourself. You are supposed to let DateGallery do this for you.

Since 1.6.0

Signature

constructor(
dateGallery : DateGallery<T> ,
date : Date ,
events : DateGalleryEvent<T> [] ,
isPadding : boolean ,
isSelected : boolean
): DateGalleryDate<T>

Parameters

dateGallery: DateGallery<T>

The DateGallery this DateGalleryDate belongs to.

date: Date

events: DateGalleryEvent<T> []

The events that lie on this date.

isPadding: boolean

Whether or not this DateGalleryDate is padding.

isSelected: boolean

Whether or not this DateGalleryDate is selected.

Properties

  • canBeSelected

    boolean

    Whether or not this DateGalleryDate can be selected, is determined by calling the canSelect from the DateGalleryConfig at the time of the DateGalleryDate construction.

    Since 1.6.0

  • date

    Date

    The date associated with this DateGalleryDate, the time of this date is midnight on 0 offset UTC.

    Since 1.6.0

  • dateGallery

    DateGallery<T>

    Reference to the DateGallery is it a part of.

    Since 1.6.0

  • events

    DateGalleryEvent<T> []

    The events that occur on this date.

    Since 1.6.0

  • hasEvents

    boolean

    Whether or not this DateGalleryDate has any events.

    Since 1.6.0

  • hasEventsWithOverlap

    boolean

    Whether or not this DateGalleryDate has events that overlap with each other. In other words whether this day has events on the same times as each other.

    Since 1.6.0

  • isPadding

    boolean

    Whether or not this DateGalleryDate is padding for the date frame. Visually these are often "greyed out" dates on month calendars, used to pad out the calendar for a nicer visual.

    Padding can only occur in one of the month modes.

    Since 1.6.0

  • isSelected

    boolean

    Whether or not this DateGalleryDate is selected.

    Since 1.6.0

  • isToday

    boolean

    Whether or not this DateGalleryDate represents a date which is today.

    Since 1.6.0

Methods

  • deselect

    Deselects the date represented by this DateGalleryDate.

    Since 1.6.0

    Signature

    deselect(): void

  • select

    Selects the date represented by this DateGalleryDate.

    Since 1.6.0

    Signature

    select(): void

  • toggle

    Toggles the date selection the date represented by this DateGalleryDate.

    If the date is selected it becomes deselected, if the date is deselected it becomes selected.

    Since 1.6.0

    Signature

    toggle(): void