| net.mygwt.ui.client.widget.Component
 net.mygwt.ui.client.widget.Container
net.mygwt.ui.client.widget.ScrollContainer
net.mygwt.ui.client.widget.List
| List | | public class List extends ScrollContainer (Code) | | Displays a list of list items.
Important: This component MUST be sized in pixels to render properly. This
can be done directly or by a layout. Percentage based sizes will not work.
- Styles:
- NONE, SINGLE, MULTI, CHECK, FLAT
- Events:
- BeforeAdd : (widget, item, index)
Fires before an item is added or inserted. Listeners can set the
doit field to false to cancel the action.
- widget : this
- item : the item being added
- index : the index at which the item will be added
- BeforeRemove : (widget, item)
Fires before an item is removed. Listeners can set the doit
field to false to cancel the action.
- widget : this
- item : the item being removed
- Add : (widget, item, index)
Fires after an item has been added or inserted.
- widget : this
- item : the item that was added
- index : the index at which the item will be added
- Remove : (widget, item)
Fires after an item has been removed.
- widget : this
- item : the item that was removed
- SelectionChange : (widget, item)
Fires after the selection changes.
- widget : this
- item : the item that is selected (single select)
- ContextMenu : (widget)
Fires before the list's context menu is shown. Listeners can set the
doit field to false to cancel the action.
- CheckChange : (widget, item)
Fires after an item is selected.
- widget : this
- item : the item that is selected (single select)
- CSS:
- .my-list (the list itself)
- .my-listitem (list item)
- .my-listitem .my-listitem-text (list item text)
|
| Constructor Summary | |
| public | List()
Creates a new single select list. | | public | List(int style)
Creates a new list with the given style. |
| maxDepth | | protected int maxDepth(Code) | | maxDepth specifies the max number of parent nodes to search in
List.findItem(Element) . Default value is 15.
|
| List | | public List()(Code) | | Creates a new single select list.
|
| List | | public List(int style)(Code) | | Creates a new list with the given style.
Parameters:
style - the style information. |
| add | | public void add(ListItem item)(Code) | | Adds an item to the list.
Parameters:
item - the item to add |
| add | | public void add(String text)(Code) | | Adds an item to the list.
Parameters:
text - the item's text |
| deselect | | public void deselect(int index)(Code) | | Deselects the item at the given index.
Parameters:
index - the index of the item to deselect |
| deselect | | public void deselect(int start, int end)(Code) | | Deselects the items at the given indices.
Parameters:
start - the start index of the items to deselect
Parameters:
end - the start index of the items to deselect |
| deselect | | public void deselect(ListItem item)(Code) | | Deselects the item at the given index.
Parameters:
item - the item to deselect |
| deselectAll | | public void deselectAll()(Code) | | Deselects all selected items.
|
| findItem | | public ListItem findItem(Element element)(Code) | | Returns the item using the specified target.
Parameters:
element - the element or child element the item |
| getChecked | | public ListItem[] getChecked()(Code) | | Returns an array of checked items.
the checked items |
| getItem | | public ListItem getItem(int index)(Code) | | Returns the item at the specified index.
Parameters:
index - the index the item |
| getItemCount | | public int getItemCount()(Code) | | Returns the number of child items.
the item count |
| getLayoutTarget | | public Element getLayoutTarget()(Code) | | |
| getSelectedItem | | public ListItem getSelectedItem()(Code) | | Returns the selected item. If the list is multi-select, returns the first
selected item.
the item or null if no selections |
| getSelection | | public ListItem[] getSelection()(Code) | | Returns the selected items.
the selected items |
| getSelectionMode | | public int getSelectionMode()(Code) | | Returns the selection mode.
the selection mode |
| indexOf | | public int indexOf(ListItem item)(Code) | | Returns the index of the item or -1 if not found.
Parameters:
item - the item the index |
| insert | | public void insert(ListItem item, int index)(Code) | | Inserts an item into the list at the given index.
Parameters:
item - the item
Parameters:
index - the insert location |
| isSelected | | public boolean isSelected(ListItem item)(Code) | | Returns true if the item is selected.
Parameters:
item - the item the select state |
| moveSelectedDown | | public void moveSelectedDown()(Code) | | Moves the current selections down one level.
|
| moveSelectedUp | | public void moveSelectedUp()(Code) | | Moves the current selections up one level.
|
| onHideContextMenu | | protected void onHideContextMenu()(Code) | | |
| onRender | | protected void onRender()(Code) | | |
| onResize | | protected void onResize(int width, int height)(Code) | | |
| remove | | public void remove(ListItem item)(Code) | | Removes the item from the list.
Parameters:
item - the item to be removed |
| removeAll | | public void removeAll()(Code) | | Removes all the items from the list.
|
| scrollIntoView | | public void scrollIntoView(ListItem item)(Code) | | Scrolls the item into view.
Parameters:
item - the item |
| select | | public void select(int index)(Code) | | Selects the item at the index. If the item at the index was already
selected, it remains selected.
Parameters:
index - the index of the item to select |
| select | | public void select(int start, int end)(Code) | | Selects the items in the range specified by the given indices. The current
selection is not cleared before the new items are selected.
Parameters:
start - the start of the range
Parameters:
end - the end of the range |
| select | | public void select(ListItem item)(Code) | | Selects the specified item.
Parameters:
item - the item to be selected |
| selectAll | | public void selectAll()(Code) | | Selects all of the items in the list. If the list is single-select, do
nothing.
|
| setContextMenu | | public void setContextMenu(Menu menu)(Code) | | |
| setSelection | | public void setSelection(ListItem item)(Code) | | Selects the item. The current selection is cleared.
Parameters:
item - the item to select |
| setSelection | | public void setSelection(ListItem[] items)(Code) | | Selects the items. The current selection is cleared.
Parameters:
items - the items to select |
| setSelectionMode | | public void setSelectionMode(int mode)(Code) | | Sets the selection mode. Valids values are SINGLE and MULTI. Has no effect
if called after the list is rendered.
Parameters:
mode - the selection mode |
| setStyle | | public void setStyle(int style)(Code) | | Sets the list's style. Has no effect if called after the list is rendered.
See the class documentation for valid styles.
Parameters:
style - the list style |
| Methods inherited from net.mygwt.ui.client.widget.Component | public void addListener(int eventType, Listener listener)(Code)(Java Doc)
public void addStyleName(String style)(Code)(Java Doc)
public void addWidgetListener(WidgetListener listener)(Code)(Java Doc)
protected void afterRender()(Code)(Java Doc)
protected Component blur()(Code)(Java Doc)
public void disable()(Code)(Java Doc)
protected void disableContextMenu(boolean disable)(Code)(Java Doc)
public void disableTextSelection(boolean disable)(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void enableEvents(boolean enable)(Code)(Java Doc)
public boolean fireEvent(int type)(Code)(Java Doc)
public boolean fireEvent(int type, BaseEvent be)(Code)(Java Doc)
public boolean fireEvent(int eventType, Widget widget, Widget item)(Code)(Java Doc)
public boolean fireEvent(int eventType, Widget widget, Widget item, int index)(Code)(Java Doc)
public Component focus()(Code)(Java Doc)
public Rectangle getBounds()(Code)(Java Doc)
public Rectangle getBounds(boolean content)(Code)(Java Doc)
protected Menu getContextMenu()(Code)(Java Doc)
public Object getData()(Code)(Java Doc)
public Object getData(String key)(Code)(Java Doc)
public String getDisabledStyle()(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
protected Element getFocusElement()(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public int getHeight(boolean content)(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public int getStyle()(Code)(Java Doc)
public ToolTip getToolTip()(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
public int getWidth(boolean content)(Code)(Java Doc)
public void hide()(Code)(Java Doc)
public boolean isDisposed()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isRendered()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
protected void onAttach()(Code)(Java Doc)
public void onBaseEvent(BaseEvent be)(Code)(Java Doc)
public void onBrowserEvent(Event event)(Code)(Java Doc)
protected void onDestroy()(Code)(Java Doc)
protected void onDetach()(Code)(Java Doc)
protected void onDisable()(Code)(Java Doc)
protected void onEnable()(Code)(Java Doc)
protected void onHide()(Code)(Java Doc)
protected void onHideContextMenu()(Code)(Java Doc)
protected void onLoad()(Code)(Java Doc)
protected void onRender()(Code)(Java Doc)
protected void onResize(int width, int height)(Code)(Java Doc)
protected void onRightClick(BaseEvent be)(Code)(Java Doc)
protected void onShow()(Code)(Java Doc)
protected void onShowContextMenu(int x, int y)(Code)(Java Doc)
public void recalculate()(Code)(Java Doc)
public void removeAllListeners()(Code)(Java Doc)
public void removeFromParent()(Code)(Java Doc)
public void removeListener(int eventType, Listener listener)(Code)(Java Doc)
public void removeStyleName(String style)(Code)(Java Doc)
public void removeWidgetListener(WidgetListener listener)(Code)(Java Doc)
protected void render()(Code)(Java Doc)
public void setBorders(boolean show)(Code)(Java Doc)
public void setBounds(int x, int y, int width, int height)(Code)(Java Doc)
public void setBounds(Rectangle rect)(Code)(Java Doc)
protected void setContextMenu(Menu menu)(Code)(Java Doc)
public void setData(Object data)(Code)(Java Doc)
public void setData(String key, Object data)(Code)(Java Doc)
public void setDisabledStyle(String style)(Code)(Java Doc)
public void setElement(Element elem)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setHeight(int height)(Code)(Java Doc)
public void setHeight(String height)(Code)(Java Doc)
public void setId(String id)(Code)(Java Doc)
public void setIntStyleAttribute(String attr, int value)(Code)(Java Doc)
public void setPagePosition(int x, int y)(Code)(Java Doc)
public void setPixelSize(int width, int height)(Code)(Java Doc)
public void setSize(int width, int height)(Code)(Java Doc)
public void setSize(String width, String height)(Code)(Java Doc)
public void setStyleAttribute(String attr, String value)(Code)(Java Doc)
public void setStyleName(String style)(Code)(Java Doc)
public void setTitle(String title)(Code)(Java Doc)
public void setToolTip(String text)(Code)(Java Doc)
public void setToolTip(String title, String text)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
public void setWidth(int width)(Code)(Java Doc)
public void setWidth(String width)(Code)(Java Doc)
public void show()(Code)(Java Doc)
public void unhook(int type, EventListener listener)(Code)(Java Doc)
|
|
|