public interface IlpTableSelectionModel extends IlpRepresentationObjectSelectionModel, IlpObjectSelectionModel
Modifier and Type | Method and Description |
---|---|
void |
addSelection(IlpArea area)
Adds an
IlpArea to the selection. |
void |
addSelection(IlpRepresentationObject object,
IlpAttribute attribute)
Adds a new selection.
|
void |
addSelectionListener(TableSelectionListener listener)
Registers a listener to selection change events.
|
void |
clearSelection()
Clears the selection.
|
IlpAttribute |
getAnchorAttribute()
Returns the attribute which has the focus.
|
IlpRepresentationObject |
getAnchorObject()
Returns the representation object which has the focus.
|
IlpArea |
getLeadSelection()
Retrieves the
IlpArea composing the temporary lead selection. |
IlpRepresentationObjectMapper |
getRepresentationObjectMapper()
Returns the
IlpRepresentationObjectMapper used
to find the IlpRepresentationObject associated
with an IlpObject . |
Collection |
getSelection()
Retrieves the collection of
IlpArea s composing the selection. |
boolean |
isAdjusting()
Returns if the selection model is currently being adjusted.
|
boolean |
isSelected(IlpArea area)
Returns whether an
IlpArea is selected. |
boolean |
isSelected(IlpRepresentationObject object,
IlpAttribute attribute)
Returns whether a cell (that is, an attribute for a representation object) is
selected.
|
void |
removeSelection(IlpArea toRemove)
Removes an
IlpArea from the selection. |
void |
removeSelection(IlpRepresentationObject object,
IlpAttribute attribute)
Removes an attribute for a representation object from the selection.
|
void |
removeSelectionListener(TableSelectionListener listener)
Removes a listener to object selection events.
|
void |
setAdjusting(boolean adjusting)
Indicates that the selection model will be changed.
|
void |
setAnchor(IlpRepresentationObject object,
IlpAttribute attribute)
Sets the cell (that is, the attribute of the representation object)
which has the focus in the table.
|
void |
setLeadSelection(IlpArea newLeadSelection)
Sets the
IlpArea composing the temporary lead selection. |
void |
setRepresentationObjectMapper(IlpRepresentationObjectMapper representationObjectMapper)
Sets the
IlpRepresentationObjectMapper which will
be used to find the IlpRepresentationObject
associated with an IlpObject . |
void |
setSelection(IlpArea newSelection)
Applies a new selection.
|
void |
setSelection(IlpRepresentationObject object,
IlpAttribute attribute)
Applies a new selection.
|
addSelectionRepresentationObject, getSelectedRepresentationObject, getSelectedRepresentationObjects, isRepresentationObjectSelected, removeSelectionRepresentationObject, removeSelectionRepresentationObjects, setSelectedRepresentationObject, setSelectedRepresentationObjects
addSelectionObject, getSelectedObject, getSelectedObjects, isObjectSelected, removeSelectionObject, setSelectedObject, setSelectedObjects
void setSelection(IlpRepresentationObject object, IlpAttribute attribute)
object
- The representation object whose attribute will be selected;
the entire row of the given representation object is selected if
the given attribute equals null
.attribute
- The attribute which will be selected for the given
representation object;
the entire column of the given attribute is selected if
the given representation object equals null
.void setSelection(IlpArea newSelection)
newSelection
- The area which will become the new selection;
if this parameter equals null
, the
selection will be cleared.Collection getSelection()
IlpArea
s composing the selection.IlpArea
s;
returns an empty collection when there is no selected area.void setLeadSelection(IlpArea newLeadSelection)
IlpArea
composing the temporary lead selection.newLeadSelection
- The IlpArea
composing the lead selection;
if this parameter equals null
, the lead selection will be
removed.IlpArea getLeadSelection()
IlpArea
composing the temporary lead selection.IlpArea
composing the lead selection;
returns null
if there is no lead selection.void addSelection(IlpRepresentationObject object, IlpAttribute attribute)
object
- the representation object whose attribute will be added to the
selection;
the entire row of the given representation object is selected if
the given attribute equals null
.attribute
- the attribute which will be added to the selection
for the given representation object;
the entire column of the given attribute is selected if
the given representation object equals null
.void addSelection(IlpArea area)
IlpArea
to the selection.area
- The area which will added to the current selection;
if this parameter equals null
, the selection will be cleared.void removeSelection(IlpRepresentationObject object, IlpAttribute attribute)
object
- The representation object whose attribute will be removed
from the selection;
the entire row of the given representation object is deselected if
the given attribute equals null
.attribute
- The attribute which will be removed from the selection
for the given representation object;
the entire column of the given attribute is deselected if
the given representation object equals null
.void removeSelection(IlpArea toRemove)
IlpArea
from the selection.toRemove
- The area which will be removed from the current selection;
if this parameter equals null
, the method has no effect.void clearSelection()
clearSelection
in interface IlpObjectSelectionModel
clearSelection
in interface IlpRepresentationObjectSelectionModel
boolean isSelected(IlpRepresentationObject object, IlpAttribute attribute)
object
- The representation object whose attribute is selected or not.attribute
- The attribute which is selected or not for
the given representation object.true
if the cell displaying the given attribute
for the given representation object is selected.boolean isSelected(IlpArea area)
IlpArea
is selected.area
- The area concerned.true
if the cell displaying the given attribute
for the given representation object is selected.void setAnchor(IlpRepresentationObject object, IlpAttribute attribute)
object
- The representation object which currently has the focus;
may be null
.attribute
- The attribute which currently has the focus;
may be null
.IlpRepresentationObject getAnchorObject()
null
.IlpAttribute getAnchorAttribute()
null
.boolean isAdjusting()
true
if changes are being performed in
the selection model.void setAdjusting(boolean adjusting)
adjusting
- Flag indicating if changes are being
performed or not in the selection model.void addSelectionListener(TableSelectionListener listener)
listener
- The listener to be registered.void removeSelectionListener(TableSelectionListener listener)
listener
- The listener to be removed.void setRepresentationObjectMapper(IlpRepresentationObjectMapper representationObjectMapper)
IlpRepresentationObjectMapper
which will
be used to find the IlpRepresentationObject
associated with an IlpObject
.representationObjectMapper
- The representation object mapper to be
used. If this parameter is null
, the IlpObject
selection
API has no effect.IlpRepresentationObjectMapper getRepresentationObjectMapper()
IlpRepresentationObjectMapper
used
to find the IlpRepresentationObject
associated
with an IlpObject
.null
.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.