Drag[en]gine Script Module DragonScript
1.23
|
Reorder list mouse listener. More...
Public Member Functions | |
void | autoScroll (float elapsed) |
Auto scroll. More... | |
String | getDesignerSelector () |
Designer selector. More... | |
int | getDragIndex () |
Index of element being dragged or -1 if not draging. More... | |
int | getDropIndex () |
Index where element would be dropped or -1 if not draging. More... | |
ListBox | getListBox () |
List box to use for reordering. More... | |
DefaultListModel | getModel () |
Model to use for reordering. More... | |
ReorderListMouseListener | new (DefaultListModel model, ListBox listBox) |
Create mouse listener reordering list model using list box. More... | |
void | onButtonPress (MouseEvent event) |
Mouse button pressed. More... | |
void | onButtonRelease (MouseEvent event) |
Mouse button release. More... | |
void | onMouseMove (MouseEvent event) |
Mouse moved. More... | |
void | setDesignerSelector (String selector) |
Set designer selector. More... | |
void | setModel (DefaultListModel model) |
Set model to use for reordering. More... | |
Public Member Functions inherited from Dragengine.Gui.Events.DefaultMouseListener | |
DefaultMouseListener | new () |
Create default mouse listener. More... | |
void | onMouseEnter (MouseEvent event) |
Mouse has entered widget. More... | |
void | onMouseLeave (MouseEvent event) |
Mouse has left widget. More... | |
void | onMouseWheel (MouseEvent event) |
Mouse wheel moved. More... | |
Protected Member Functions | |
Widget | createDropWidget () |
Create drop widget. More... | |
bool | elementCanMoveTo (int index) |
Element can be moved to index. More... | |
bool | elementCanReorder (int index) |
Element at index can be reordered. More... | |
int | indexClosestDropPosition () |
Index of element closest to current drop position or -1. More... | |
void | listBoxAddDropWidgetCanvas () |
Add drop widget canvas to list box. More... | |
void | listBoxRemoveDropWidgetCanvas () |
Remove drop widget canvas from list box. More... | |
void | onStartDrag () |
Start draging. More... | |
void | onStopDrag () |
Stop draging. More... | |
void | onUpdateDrag () |
Update draging. More... | |
void | updateDropWidget () |
Update drop widget. More... | |
Reorder list mouse listener.
Allows user to reorder elements in a ListBox using mouse drag and drop. This requires the user to provide an DefaultListModel and a ListBox to use for the reordering. The list model used to reorder can be different from the one used for the ListBox as long as the list box model reflects the changes.
void Dragengine.Gui.ReorderListMouseListener.autoScroll | ( | float | elapsed | ) |
Auto scroll.
|
protected |
|
protected |
Element can be moved to index.
Default implementation returns true. Subclass can overwrite to prevent draged element from being dropped at certain positions.
|
protected |
Element at index can be reordered.
Default implementation returns true. Subclass can overwrite to prevent certain elements from being reordered.
String Dragengine.Gui.ReorderListMouseListener.getDesignerSelector | ( | ) |
Designer selector.
Selects designer from gui theme. Selector composes of alphanumeric identifier. A chain of identifiers can be specified separated by periods. If a chain is defined the full chain is first checked to find the designer. If not found the right most identifier is stripped and the remaining chain checked for a match. The first match is used. This allows to add optional quallifier identifers at the end of the chain for future use while still matching broader designers in the mean time.
If null designer is used from gui theme.
int Dragengine.Gui.ReorderListMouseListener.getDragIndex | ( | ) |
Index of element being dragged or -1 if not draging.
int Dragengine.Gui.ReorderListMouseListener.getDropIndex | ( | ) |
Index where element would be dropped or -1 if not draging.
ListBox Dragengine.Gui.ReorderListMouseListener.getListBox | ( | ) |
List box to use for reordering.
DefaultListModel Dragengine.Gui.ReorderListMouseListener.getModel | ( | ) |
Model to use for reordering.
|
protected |
Index of element closest to current drop position or -1.
|
protected |
Add drop widget canvas to list box.
|
protected |
Remove drop widget canvas from list box.
ReorderListMouseListener Dragengine.Gui.ReorderListMouseListener.new | ( | DefaultListModel | model, |
ListBox | listBox | ||
) |
Create mouse listener reordering list model using list box.
void Dragengine.Gui.ReorderListMouseListener.onButtonPress | ( | MouseEvent | event | ) |
Mouse button pressed.
Captures mouse and starts tracking if an item is clicked upon.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
void Dragengine.Gui.ReorderListMouseListener.onButtonRelease | ( | MouseEvent | event | ) |
Mouse button release.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
void Dragengine.Gui.ReorderListMouseListener.onMouseMove | ( | MouseEvent | event | ) |
Mouse moved.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
|
protected |
Start draging.
Index of element to reorder can be obtained using getDragIndex().
|
protected |
Stop draging.
Index of element to reorder can be obtained using getDragIndex(). Index of position where element is dropped can be obtained using getDropIndex().
|
protected |
Update draging.
Index of element to reorder can be obtained using getDragIndex(). Index of position where the element would be dropped can be obtained using getDropIndex().
void Dragengine.Gui.ReorderListMouseListener.setDesignerSelector | ( | String | selector | ) |
Set designer selector.
Selects designer from gui theme. Selector composes of alphanumeric identifier. A chain of identifiers can be specified separated by periods. If a chain is defined the full chain is first checked to find the designer. If not found the right most identifier is stripped and the remaining chain checked for a match. The first match is used. This allows to add optional quallifier identifers at the end of the chain for future use while still matching broader designers in the mean time.
If null designer is used from gui theme.
void Dragengine.Gui.ReorderListMouseListener.setModel | ( | DefaultListModel | model | ) |
Set model to use for reordering.
|
protected |
Update drop widget.
Removes drop widget canvases if present. If getDropIndex() is not -1 uses getDropCanvasCreator() to create canvas with position and size of the drop element.