|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.event.BaseObservable
com.extjs.gxt.ui.client.binder.StoreBinder<S,C,M>
S
- the store typeC
- the component being boundM
- the model typepublic abstract class StoreBinder<S extends Store<M>,C extends Component,M extends ModelData>
Abstract base class for all Store Binders. Binders provide model support to
data widgets by binding a Store
to a component.
Field Summary | |
---|---|
protected C |
component
|
protected ModelStringProvider<M> |
defaultStringProvider
|
protected ModelStringProvider<M> |
iconProvider
|
protected StoreListener<M> |
listener
|
protected S |
store
|
protected ModelStringProvider<M> |
stringProvider
|
protected ModelStringProvider<M> |
styleProvider
|
Constructor Summary | |
---|---|
StoreBinder(S store,
C container)
Creates a new binder instance. |
Method Summary | |
---|---|
void |
addSelectionChangedListener(SelectionChangedListener<M> listener)
Add a selection changed listener. |
protected void |
bind(S store)
|
protected abstract void |
createAll()
|
abstract Component |
findItem(M model)
Returns the matching component for the given model. |
protected void |
fireSelectionChanged(SelectionChangedEvent<M> se)
|
protected java.lang.String |
getIconValue(M model,
java.lang.String property)
|
java.util.List<M> |
getSelection()
Returns the current selection. |
protected abstract java.util.List<M> |
getSelectionFromComponent()
|
Store<M> |
getStore()
Returns the binder's store. |
protected java.lang.String |
getTextValue(M model,
java.lang.String property)
|
protected java.lang.String |
getTextValue(M model,
java.lang.String property,
boolean useDefault)
|
protected void |
hook()
|
void |
init()
Must be called after the binder had been configured. |
boolean |
isAutoSelect()
Returns true if select on load is enabled. |
boolean |
isFiltered(M parent,
M child)
Returns whether the given model is filtered. |
boolean |
isMask()
Returns true if masking is enabled. |
protected abstract void |
onAdd(StoreEvent<M> se)
|
protected void |
onBeforeDataChanged(StoreEvent<M> se)
|
protected void |
onClear(StoreEvent<M> se)
|
protected void |
onDataChanged(StoreEvent<M> se)
|
protected void |
onFilter(StoreEvent<M> se)
|
protected abstract void |
onRemove(StoreEvent<M> se)
|
protected void |
onSort(StoreEvent<M> se)
|
protected abstract void |
onUpdate(StoreEvent<M> se)
|
protected abstract void |
removeAll()
|
void |
removeSelectionListener(SelectionChangedListener<M> listener)
Removes a selection changed listener. |
void |
setAutoSelect(boolean autoSelect)
True to select the first model after the store's data changes. |
void |
setIconProvider(ModelStringProvider<M> iconProvider)
Sets the binder's icon provider. |
void |
setMask(boolean mask)
Sets whether a mask should be displayed during a load operation. |
protected void |
setModel(Component c,
ModelData model)
|
void |
setSelection(java.util.List<M> selection)
Sets the current selection for this selection provider. |
void |
setSelection(M selection)
Sets the current selection for this selection provider. |
protected abstract void |
setSelectionFromProvider(java.util.List<M> selection)
|
void |
setStringProvider(ModelStringProvider<M> stringProvider)
Sets the binder's string provider. |
void |
setStyleProvider(ModelStringProvider<M> styleProvider)
Sets the binder's style provider. |
protected abstract void |
update(M model)
|
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable |
---|
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected S extends Store<M> store
protected C extends Component component
protected StoreListener<M extends ModelData> listener
protected ModelStringProvider<M extends ModelData> stringProvider
protected ModelStringProvider<M extends ModelData> iconProvider
protected ModelStringProvider<M extends ModelData> styleProvider
protected ModelStringProvider<M extends ModelData> defaultStringProvider
Constructor Detail |
---|
public StoreBinder(S store, C container)
store
- the storecontainer
- the containerMethod Detail |
---|
public void addSelectionChangedListener(SelectionChangedListener<M> listener)
SelectionProvider
addSelectionChangedListener
in interface SelectionProvider<M extends ModelData>
listener
- a selection changed listenerpublic abstract Component findItem(M model)
model
- the model
public java.util.List<M> getSelection()
SelectionProvider
getSelection
in interface SelectionProvider<M extends ModelData>
public Store<M> getStore()
public void init()
public boolean isAutoSelect()
public boolean isFiltered(M parent, M child)
parent
- the model parentchild
- the child model
public boolean isMask()
public void removeSelectionListener(SelectionChangedListener<M> listener)
SelectionProvider
removeSelectionListener
in interface SelectionProvider<M extends ModelData>
listener
- a selection changed listenerpublic void setAutoSelect(boolean autoSelect)
autoSelect
- true to auto selectpublic void setIconProvider(ModelStringProvider<M> iconProvider)
iconProvider
- the icon providerpublic void setMask(boolean mask)
mask
- true for maskpublic void setSelection(java.util.List<M> selection)
SelectionProvider
setSelection
in interface SelectionProvider<M extends ModelData>
selection
- the new selectionpublic void setSelection(M selection)
selection
- the selectionpublic void setStringProvider(ModelStringProvider<M> stringProvider)
stringProvider
- the string providerpublic void setStyleProvider(ModelStringProvider<M> styleProvider)
styleProvider
- the style providerprotected void bind(S store)
protected abstract void createAll()
protected void fireSelectionChanged(SelectionChangedEvent<M> se)
protected java.lang.String getIconValue(M model, java.lang.String property)
protected abstract java.util.List<M> getSelectionFromComponent()
protected java.lang.String getTextValue(M model, java.lang.String property)
protected java.lang.String getTextValue(M model, java.lang.String property, boolean useDefault)
protected void hook()
protected abstract void onAdd(StoreEvent<M> se)
protected void onBeforeDataChanged(StoreEvent<M> se)
protected void onClear(StoreEvent<M> se)
protected void onDataChanged(StoreEvent<M> se)
protected void onFilter(StoreEvent<M> se)
protected abstract void onRemove(StoreEvent<M> se)
protected void onSort(StoreEvent<M> se)
protected abstract void onUpdate(StoreEvent<M> se)
protected abstract void removeAll()
protected void setModel(Component c, ModelData model)
protected abstract void setSelectionFromProvider(java.util.List<M> selection)
protected abstract void update(M model)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |