kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-16 11:02:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4907 from Softpagehomeware/bugfix/marionette/generics_for_collections

Browse Source 
fixed the Collection- / Composite child view issue.
This commit is contained in:
Masahiro Wakame
2015-08-21 22:34:32 +09:00
parent 16af44634f 2d2a7cc0d4
commit ecbdfe2832
3 changed files with 47 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
backbone/backbone.d.ts vendored
View File

@@ -309,7 +309,8 @@ declare module Backbone {
interface ViewOptions<TModel extends Model> {
model?: TModel;
collection?: Backbone.Collection<TModel>;
// TODO: quickfix, this can't be fixed easy. The collection does not need to have the same model as the parent view.
collection?: Backbone.Collection<any>;
el?: any;
id?: string;
className?: string;

2
marionette/marionette-tests.ts
View File

@@ -179,7 +179,7 @@ module Marionette.Tests {
}
}
class MyCollectionView extends Marionette.CollectionView<MyModel> {
class MyCollectionView extends Marionette.CollectionView<MyModel, MyView> {
constructor() {
this.childView = MyView;
this.childEvents = {

88
marionette/marionette.d.ts vendored
View File

@@ -9,49 +9,49 @@
declare module Backbone {
// Backbone.BabySitter
class ChildViewContainer<TModel extends Backbone.Model> {
class ChildViewContainer<TView extends View<Backbone.Model>> {
constructor(initialViews?: any[]);
add(view: View<TModel>, customIndex?: number): void;
findByModel(model: TModel): View<TModel>;
findByModelCid(modelCid: string): View<TModel>;
findByCustom(index: number): View<TModel>;
findByIndex(index: number): View<TModel>;
findByCid(cid: string): View<TModel>;
remove(view: View<TModel>): void;
add(view: TView, customIndex?: number): void;
findByModel<TModel extends Backbone.Model>(model: TModel): TView;
findByModelCid(modelCid: string): TView;
findByCustom(index: number): TView;
findByIndex(index: number): TView;
findByCid(cid: string): TView;
remove(view: TView): void;
call(method: any): void;
apply(method: any, args?: any[]): void;
//mixins from Collection (copied from Backbone's Collection declaration)
all(iterator: (element: View<TModel>, index: number) => boolean, context?: any): boolean;
any(iterator: (element: View<TModel>, index: number) => boolean, context?: any): boolean;
all(iterator: (element: TView, index: number) => boolean, context?: any): boolean;
any(iterator: (element: TView, index: number) => boolean, context?: any): boolean;
contains(value: any): boolean;
detect(iterator: (item: any) => boolean, context?: any): any;
each(iterator: (element: View<TModel>, index: number, list?: any) => void, context?: any): any;
every(iterator: (element: View<TModel>, index: number) => boolean, context?: any): boolean;
filter(iterator: (element: View<TModel>, index: number) => boolean, context?: any): View<TModel>[];
find(iterator: (element: View<TModel>, index: number) => boolean, context?: any): View<TModel>;
first(): View<TModel>;
forEach(iterator: (element: View<TModel>, index: number, list?: any) => void, context?: any): void;
each(iterator: (element: TView, index: number, list?: any) => void, context?: any): any;
every(iterator: (element: TView, index: number) => boolean, context?: any): boolean;
filter(iterator: (element: TView, index: number) => boolean, context?: any): TView[];
find(iterator: (element: TView, index: number) => boolean, context?: any): TView;
first(): TView;
forEach(iterator: (element: TView, index: number, list?: any) => void, context?: any): void;
include(value: any): boolean;
initial(): View<TModel>;
initial(n: number): View<TModel>[];
initial(): TView;
initial(n: number): TView[];
invoke(methodName: string, args?: any[]): any;
isEmpty(object: any): boolean;
last(): View<TModel>;
last(n: number): View<TModel>[];
lastIndexOf(element: View<TModel>, fromIndex?: number): number;
map<U>(iterator: (element: View<TModel>, index: number, context?: any) => U, context?: any): U[];
last(): TView;
last(n: number): TView[];
lastIndexOf(element: TView, fromIndex?: number): number;
map<U>(iterator: (element: TView, index: number, context?: any) => U, context?: any): U[];
pluck(attribute: string): any[];
reject(iterator: (element: View<TModel>, index: number) => boolean, context?: any): View<TModel>[];
rest(): View<TModel>;
rest(n: number): View<TModel>[];
reject(iterator: (element: TView, index: number) => boolean, context?: any): TView[];
rest(): TView;
rest(n: number): TView[];
select(iterator: any, context?: any): any[];
some(iterator: (element: View<TModel>, index: number) => boolean, context?: any): boolean;
some(iterator: (element: TView, index: number) => boolean, context?: any): boolean;
toArray(): any[];
without(...values: any[]): View<TModel>[];
without(...values: any[]): TView[];
}
// Backbone.Wreqr
@@ -856,7 +856,7 @@ declare module Marionette {
* DOM. This behavior can be disabled by specifying {sort: false} on
* initialize.
*/
class CollectionView<TModel extends Backbone.Model> extends View<TModel> {
class CollectionView<TModel extends Backbone.Model, TView extends View<Backbone.Model>> extends View<TModel> {
constructor(options?: CollectionViewOptions<TModel>);
/**
@@ -864,7 +864,7 @@ declare module Marionette {
* Backbone view object definition, not an instance. It can be any
* Backbone.View or be derived from Marionette.ItemView
*/
childView: any;
childView: new (...args:any[]) => TView;
/**
* There may be scenarios where you need to pass data from your parent
@@ -918,14 +918,14 @@ declare module Marionette {
* collection view, iterate them, find them by a given indexer such as the
* view's model or collection, and more.
*/
children: Backbone.ChildViewContainer<TModel>;
children: Backbone.ChildViewContainer<TView>;
/**
* The render method of the collection view is responsible for rendering the
* entire collection. It loops through each of the children in the collection
* and renders them individually as an childView.
*/
render(): CollectionView<TModel>;
render(): CollectionView<TModel, TView>;
/**
* The addChild method is responsible for rendering the childViews and
@@ -933,9 +933,9 @@ declare module Marionette {
* responsible for triggering the events per ChildView. In most cases you
* should not override this method.
*/
addChild(item: any, ChildView: Backbone.View<TModel>, index: Number): void;
addChild(item: any, ChildView: TView, index: Number): void;
renderChildView(view: Backbone.View<TModel>, index: Number): void;
renderChildView(view: TView, index: Number): void;
/**
* When a custom view instance needs to be created for the childView that
@@ -943,13 +943,13 @@ declare module Marionette {
* takes three parameters and returns a view instance to be used as the
* child view.
*/
buildChildView(child: any, ItemViewType: any, itemViewOptions: any): View<TModel>;
buildChildView(child: any, ItemViewType: any, itemViewOptions: any): TView;
/**
* Remove the child view and destroy it. This function also updates the indices of
* later views in the collection in order to keep the children in sync with the collection.
*/
removeChildView(view: any): void;
removeChildView(view: TView): void;
/**
* Determines if the view is empty. If you want to control when the empty
@@ -988,14 +988,14 @@ declare module Marionette {
* a collection and displaying the sorted list in the correct order on the
* screen.
*/
attachHtml(collectionView: CollectionView<TModel>, childView: Backbone.View<TModel>, index: number): void;
attachHtml(collectionView: CollectionView<TModel, TView>, childView: TView, index: number): void;
/**
* The value returned by this method is the ChildView class that will be
* instantiated when a Model needs to be initially rendered. This method
* also gives you the ability to customize per Model ChildViews.
*/
getChildView(item: TModel): any;
getChildView<M extends Backbone.Model>(item: M): new (...args:any[]) => TView;
/**
* If you need the emptyView's class chosen dynamically, specify
@@ -1020,27 +1020,27 @@ declare module Marionette {
* instance is about to be added to the collection view. It provides
* access to the view instance for the child that was added.
*/
onBeforeAddChild(view: any): void;
onBeforeAddChild(childView: TView): void;
/**
* This callback function allows you to know when a child / child view
* instance has been added to the collection view. It provides access to
* the view instance for the child that was added.
*/
onAddChild(childView: any): void;
onAddChild(childView: TView): void;
/**
* This callback function allows you to know when a childView instance is
* about to be removed from the collectionView. It provides access to the
* view instance for the child that was removed.
*/
onBeforeRemoveChild(childView: any): void;
onBeforeRemoveChild(childView: TView): void;
/**
* This callback function allows you to know when a child / childView
* instance has been deleted or removed from the collection.
*/
onRemoveChild(childView: any): void;
onRemoveChild(childView: TView): void;
}
/**
@@ -1049,7 +1049,7 @@ declare module Marionette {
* structure, or for scenarios where a collection needs to be rendered within
* a wrapper template.
*/
class CompositeView<TModel extends Backbone.Model> extends CollectionView<TModel> {
class CompositeView<TModel extends Backbone.Model, TView extends View<Backbone.Model>> extends CollectionView<TModel, TView> {
constructor(options?: CollectionViewOptions<TModel>);
@@ -1058,7 +1058,7 @@ declare module Marionette {
* CompositeView's template is rendered and the childView's templates are
* added to this.
*/
childView: any;
childView: new (...args:any[]) => TView;
/**
* By default the composite view uses the same attachHtml method that the
@@ -1074,7 +1074,7 @@ declare module Marionette {
/**
* Renders the view.
*/
render(): CompositeView<TModel>;
render(): CompositeView<TModel, TView>;
/**
* Invoked before the model has been rendered