public abstract static class ListButtons.Controller
extends java.lang.Object
Constructor and Description |
---|
ListButtons.Controller() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addToList()
Handles the user pressing the add button.
|
boolean |
canAdd() |
boolean |
canMoveDown(java.lang.Object val) |
boolean |
canMoveUp(java.lang.Object val) |
boolean |
canRemove() |
boolean |
canRemove(java.lang.Object val) |
boolean |
canReorder() |
void |
customButtonPressed(java.lang.String buttonName)
If you add any custom buttons to the ListButtons instance, you must
provide a controller subclass that can handle the button action
by overridding this method.
|
java.lang.String |
getAddTooltipText() |
java.lang.String |
getBaseName()
Gets the base name to use for naming the button components (for
testability).
|
java.lang.String |
getBottomTooltipText() |
java.lang.String |
getDownTooltipText() |
java.lang.String |
getListLabel()
Gets the label for the list of objects (will be placed in the control
bar).
|
java.lang.Integer |
getMaxListSize() |
java.lang.String |
getRemoveTooltipText() |
protected SelectableComponent |
getSelectableComponent()
Gets the SelectableComponent being controlled.
|
java.lang.String |
getTopTooltipText() |
java.lang.String |
getUpTooltipText() |
boolean |
includeAddRemoveButtons() |
boolean |
includeReorderButtons() |
boolean |
isButtonEnabled(java.lang.String buttonName)
Tests whether the given custom button is enabled.
|
void |
objectMovedDown(java.lang.Object obj)
This is called if the user succesfully moves an object "down" in the
list.
|
void |
objectMovedUp(java.lang.Object obj)
This is called if the user succesfully moves an object "up" in the
list.
|
void |
removeFromList()
Handles the user pressing the remove button.
|
boolean |
useResizeComponent()
Tests whether the component should be wrapped in a
ResizeComponent . |
protected final SelectableComponent getSelectableComponent()
public abstract void addToList()
public void removeFromList()
public java.lang.String getBaseName()
public java.lang.String getListLabel()
public boolean useResizeComponent()
ResizeComponent
.public void customButtonPressed(java.lang.String buttonName)
buttonName
- the name of the custom button that has been
pushed.public boolean isButtonEnabled(java.lang.String buttonName)
public boolean includeAddRemoveButtons()
public boolean includeReorderButtons()
public boolean canRemove(java.lang.Object val)
public boolean canRemove()
public boolean canAdd()
public java.lang.Integer getMaxListSize()
public boolean canMoveUp(java.lang.Object val)
public boolean canMoveDown(java.lang.Object val)
public boolean canReorder()
public java.lang.String getAddTooltipText()
public java.lang.String getRemoveTooltipText()
public java.lang.String getUpTooltipText()
public java.lang.String getDownTooltipText()
public java.lang.String getTopTooltipText()
public java.lang.String getBottomTooltipText()
public void objectMovedUp(java.lang.Object obj)
obj
- the object that the user has movedpublic void objectMovedDown(java.lang.Object obj)
obj
- the object that the user has moved