ScheduleViewController<T extends Object?> class abstract

Inheritance

• Object
• ViewController<T>
• ScheduleViewController

Implementers

• ContinuousScheduleViewController
• PaginatedScheduleViewController

Constructors

ScheduleViewController({required ScheduleViewConfiguration viewConfiguration, required ValueNotifier<DateTimeRange<DateTime>> visibleDateTimeRange, required ValueNotifier<Set<CalendarEvent<T>>> visibleEvents, required DateTime initialDate})

Properties

cache → EventLayoutDelegateCache

TODO: this can be passed between ViewControllers, but for now it is created here. The cache used by the event layout delegate.

final, inherited

currentPage ↔ int

The index of the current page.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasInitialized → bool

Check if the controller has been initialized with the necessary components.

no setter

highlightedDateTimeRange → ValueNotifier<DateTimeRange<DateTime>?>

The highlighted date time range.

final

initialDate → DateTime

The initial date to display in the schedule view.

final

itemCount → int

Get the number of items for the current page.

no setter

itemPositionsListener ↔ ItemPositionsListener?

The ItemPositionsListener used to listen to the scroll position of the list.

getter/setter pair

itemScrollController ↔ ItemScrollController?

The ItemScrollController used to control the scrollable list of the current page.

getter/setter pair

multiDayCache → MultiDayLayoutFrameCache<T>

The cache used for the multi-day event layout.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

viewConfiguration → ScheduleViewConfiguration

The view configuration that will be used by the controller.

final

visibleDateTimeRange ↔ ValueNotifier<DateTimeRange<DateTime>>

The DateTimeRange that is currently visible.

late, final, override-getter

visibleEvents ↔ ValueNotifier<Set<CalendarEvent<T>>>

The CalendarEvents that are currently visible.

late, final, override-getter

Methods

addItem({required ListItem item, required DateTime date, bool isFirst = false}) → void

Add an item to the schedule map of the current page.

addItemForPage({required ListItem item, required DateTime date, required int pageIndex, bool isFirst = false}) → void

Add an item to the map.

inherited

animateToDate(DateTime date, {Duration? duration, Curve? curve}) → Future<void>

Animate to the date part of the given DateTime.

inherited

animateToDateTime(DateTime date, {Duration? pageDuration, Curve? pageCurve, Duration? scrollDuration, Curve? scrollCurve}) → Future<void>

Animate to the date and time parts of the given DateTime.

inherited

animateToEvent(CalendarEvent<T> event, {Duration? pageDuration, Curve? pageCurve, Duration? scrollDuration, Curve? scrollCurve, bool centerEvent = true}) → Future<void>

Animate to the given CalendarEvent.

inherited

animateToNextPage({Duration? duration, Curve? curve}) → Future<void>

Animate to the next page.

inherited

animateToPreviousPage({Duration? duration, Curve? curve}) → Future<void>

Animate to the previous page.

inherited

clear() → void

Clear the schedule map for the current page.

clearPage(int pageIndex) → void

inherited

closestIndex(DateTime date) → int

Get the index closest to the given DateTime of the current page.

closestIndexForPage(int pageIndex, DateTime date) → int

Find the index closest to the given date.

inherited

closestMonthIndex(int pageIndex, DateTime date) → int

Get the month index for the given pageIndex and date.

inherited

dateTimeFromIndex(int index) → DateTime?

Get the DateTime for the given index of the current page.

dateTimeFromIndexForPage(int pageIndex, int itemIndex) → DateTime?

Get the DateTime for the given pageIndex and itemIndex.

inherited

dateTimeItemIndex(int pageIndex) → DateTimeItemIndex

Get the DateTimeItemIndex for the given pageIndex.

inherited

dispose() → void

override

indexFromDateTime(DateTime date) → int?

Get the index of the item for the given DateTime for the current page.

indexFromDateTimeForPage(int pageIndex, DateTime date) → int?

inherited

indexItem(int pageIndex) → IndexItem

Get the IndexItem for the given pageIndex.

inherited

initialScrollIndex(DateTime date) → int

Find the initial scroll index for the given date.

item(int index) → ListItem?

Get the item at the given index of the current page.

itemCountForPage(int pageIndex) → int

Get the number of items for the given pageIndex.

inherited

itemIndexDateTime(int pageIndex) → IndexItemDateTime

Get the IndexItemDateTime for the given pageIndex.

inherited

jumpToDate(DateTime date) → FutureOr<void>

Jump to the given DateTime.

inherited

jumpToPage(int page) → void

Jump to the given DateTime.

inherited

monthIndexFromDateTime(int pageIndex, DateTime date) → int?

Get the month index for the given pageIndex and date.

inherited

monthIndices(int pageIndex) → DateTimeItemIndex

Get the DateTimeItemIndex for the given pageIndex.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

populateMaps(int numberOfPages) → void

Populate the maps with the given number of pages.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited