|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.extjs.gxt.ui.client.widget.Component
com.extjs.gxt.ui.client.widget.BoxComponent
com.extjs.gxt.ui.client.widget.form.Field<D>
com.extjs.gxt.ui.client.widget.form.ListField<D>
D
- the model typepublic class ListField<D extends ModelData>
A multi-select list field.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field |
---|
Field.FieldImages, Field.FieldMessages |
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled |
Field Summary | |
---|---|
protected ListView<D> |
listView
|
protected ListStore<D> |
store
|
Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field |
---|
autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value |
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent |
---|
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width |
Fields inherited from class com.extjs.gxt.ui.client.widget.Component |
---|
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
ListField()
|
Method Summary | |
---|---|
void |
addSelectionChangedListener(SelectionChangedListener<D> listener)
Add a selection changed listener. |
void |
disable()
Disable this component. |
protected void |
doAttachChildren()
|
protected void |
doDetachChildren()
|
void |
enable()
Enable this component. |
java.lang.String |
getDisplayField()
Returns the display field. |
protected El |
getInputEl()
Provides support for wrapping the actual input element. |
java.lang.String |
getItemSelector()
Returns the item selector. |
ListView<D> |
getListView()
Returns the field's list view. |
ListModelPropertyEditor<D> |
getPropertyEditor()
Returns the field's property editor. |
java.lang.String |
getRawValue()
Returns the raw data value which may or may not be a valid, defined value. |
java.util.List<D> |
getSelection()
Returns the current selection. |
ListStore<D> |
getStore()
Returns the field's store. |
XTemplate |
getTemplate()
Returns the custom template. |
D |
getValue()
Returns the typed value of the field. |
java.lang.String |
getValueField()
|
protected void |
onFocus(ComponentEvent ce)
|
protected void |
onRender(com.google.gwt.user.client.Element parent,
int index)
Subclasses must override and ensure setElement is called for lazy rendered components. |
protected void |
onResize(int width,
int height)
Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs. |
protected void |
onSelectionChange(java.util.List<D> sel)
|
void |
removeSelectionListener(SelectionChangedListener<D> listener)
Removes a selection changed listener. |
void |
setDisplayField(java.lang.String displayField)
Sets the display field. |
void |
setItemSelector(java.lang.String itemSelector)
This setting is required if a custom XTemplate has been specified. |
void |
setPropertyEditor(PropertyEditor<D> propertyEditor)
Sets the field's property editor which is used to translate typed values to string, and string values back to typed values. |
void |
setSelection(java.util.List<D> selection)
Sets the current selection for this selection provider. |
void |
setStore(ListStore<D> store)
Sets the list field's list store. |
void |
setTemplate(java.lang.String html)
Sets the field's template used to render the list. |
void |
setTemplate(XTemplate template)
Sets the field's template used to render the list. |
void |
setValue(D value)
Sets a data value into the field and validates it. |
void |
setValueField(java.lang.String valueField)
Sets the field's value field. |
protected boolean |
validateValue(java.lang.String value)
Subclasses should provide the validation implementation by overriding this. |
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent |
---|
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected ListView<D extends ModelData> listView
protected ListStore<D extends ModelData> store
Constructor Detail |
---|
public ListField()
Method Detail |
---|
public void addSelectionChangedListener(SelectionChangedListener<D> listener)
SelectionProvider
addSelectionChangedListener
in interface SelectionProvider<D extends ModelData>
listener
- a selection changed listenerpublic void disable()
Component
disable
in class Component
public void enable()
Component
enable
in class Component
public java.lang.String getDisplayField()
public java.lang.String getItemSelector()
public ListView<D> getListView()
public ListModelPropertyEditor<D> getPropertyEditor()
Field
getPropertyEditor
in class Field<D extends ModelData>
public java.lang.String getRawValue()
Field
Field.getValue()
.
getRawValue
in class Field<D extends ModelData>
public java.util.List<D> getSelection()
SelectionProvider
getSelection
in interface SelectionProvider<D extends ModelData>
public ListStore<D> getStore()
public XTemplate getTemplate()
public D getValue()
Field
getValue
in class Field<D extends ModelData>
public java.lang.String getValueField()
public void removeSelectionListener(SelectionChangedListener<D> listener)
SelectionProvider
removeSelectionListener
in interface SelectionProvider<D extends ModelData>
listener
- a selection changed listenerpublic void setDisplayField(java.lang.String displayField)
displayField
- the display fieldpublic void setItemSelector(java.lang.String itemSelector)
itemSelector
- the item selectorpublic void setPropertyEditor(PropertyEditor<D> propertyEditor)
Field
setPropertyEditor
in class Field<D extends ModelData>
propertyEditor
- the property editorpublic void setSelection(java.util.List<D> selection)
SelectionProvider
setSelection
in interface SelectionProvider<D extends ModelData>
selection
- the new selectionpublic void setValue(D value)
Field
Field.setRawValue(java.lang.String)
.
setValue
in class Field<D extends ModelData>
value
- the value to setpublic void setStore(ListStore<D> store)
store
- the storepublic void setTemplate(java.lang.String html)
html
- the html framentpublic void setTemplate(XTemplate template)
template
- public void setValueField(java.lang.String valueField)
valueField
- the value fieldprotected void doAttachChildren()
doAttachChildren
in class Component
protected void doDetachChildren()
doDetachChildren
in class Field<D extends ModelData>
protected El getInputEl()
Field
getInputEl
in class Field<D extends ModelData>
protected void onFocus(ComponentEvent ce)
onFocus
in class Field<D extends ModelData>
protected void onRender(com.google.gwt.user.client.Element parent, int index)
Component
onRender
in class Field<D extends ModelData>
parent
- the target elementindex
- the insert locationprotected void onResize(int width, int height)
BoxComponent
onResize
in class Field<D extends ModelData>
width
- the widthheight
- the heightprotected void onSelectionChange(java.util.List<D> sel)
protected boolean validateValue(java.lang.String value)
Field
validateValue
in class Field<D extends ModelData>
value
- the value to validate
true
for valid
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |