public class TLcdKML22RenderableModel extends ALcdModel implements ILcd2DBoundsIndexedModel, ILcdTimeBounded, ReadWriteLock
TLcdKML22DynamicModel
that prepares the model for rendering. It performs the following steps:
ILcdModel.Query
fModelEventSupport
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel)
Constructs a
TLcdKML22Model object based on the given delegate
TLcdKML22ModelTreeNode . |
TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel,
List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
Constructs a
TLcdKML22Model object based on the given delegate
TLcdKML22ModelTreeNode . |
Modifier and Type | Method and Description |
---|---|
void |
addElement(Object aElement,
int aEventMode)
Adds the specified element to this model.
|
void |
addElements(Vector aElements,
int aEventMode)
Adds all of the elements in the specified vector to this model.
|
void |
addModelListener(ILcdModelListener aModelListener)
Registers the specified model listener to receive notifications of model changes on this model.
|
void |
addPropertyChangeListener(PropertyChangeListener aListener)
Registers a property change listener to this model
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Applies the specified function to all the model elements that meet the specified filter.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Applies the specified function to all the model elements that meet the specified filter.
|
boolean |
canAddElement(Object aElement)
Returns
true if the specified element can be added to this model, false otherwise. |
boolean |
canRemoveElement(Object aElement)
Returns
true if the specified element can be removed from this model, false otherwise. |
void |
dispose()
Disposes of this model and allows it to release any system resources that it is holding.
|
void |
elementChanged(Object aElement,
int aEventMode)
Notifies this model that the specified element has changed.
|
Enumeration |
elements()
Returns an enumeration over all elements of this model.
|
Enumeration |
elements(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder)
Returns an enumeration over all elements of this model that meet the specified filter.
|
void |
elementsChanged(Vector aElements,
int aEventMode)
Notifies this model that the elements in the specified vector have changed.
|
void |
fireCollectedModelChanges()
Notifies all listeners that are registered on this model of all the changes that have been collected between the
previous notification and now.
|
protected void |
firePropertyChange(PropertyChangeEvent aPropertyChangeEvent)
Fires a property change to all registered listeners.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
ILcdBounds |
getBounds(ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
ILcdFilter aElementFilter)
Returns the union of all spatial bounds of the elements in this model that meet the specified
filter.
|
List<EnumSet<ELcdKML22ContentType>> |
getDefaultContentTypeOrder()
A list of EnumSet instances that each define a grouping of elements.
|
ILcdTimeBounds |
getDefaultFilterTimeBounds()
Returns the content type ordering to apply when performing a call to a
applyOnInteract
or elements method that does not take a content type parameter. |
TLcdKML22DynamicModel |
getDelegateModel()
Returns the
TLcdKML22DynamicModel that this wrapped by this TLcdKML22RenderableModel |
ILcdModelDescriptor |
getModelDescriptor()
Returns the
ILcdModelDescriptor providing meta information about this model and
its elements. |
ILcdModelEncoder |
getModelEncoder()
Returns, if available, a model encoder that is capable of encoding this model,
(
encoder.canEncode(this) ), null otherwise. |
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
ILcdTimeBounds |
getTimeBounds()
Returns the
ILcdTimeBounds by which this object is bounded. |
ILcdTimeBounds |
getTimeBounds(ILcdBounds aSpatialBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
ILcdFilter aElementFilter,
boolean aIgnoreUnboundedTimeBounds)
Returns the union of all time bounds of the elements in the hierarchy of the delegate model
that meet the specified filter.
|
Lock |
readLock() |
void |
removeAllElements(int aEventMode)
Removes all elements from this model.
|
void |
removeElement(Object aElement,
int aEventMode)
Removes the specified element from this model.
|
void |
removeElements(Vector aElements,
int aEventMode)
Removes all of the elements in the specified vector from this model.
|
void |
removeModelListener(ILcdModelListener aModelListener)
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
|
void |
removePropertyChangeListener(PropertyChangeListener aListener)
Removes a property change listener from this model
|
void |
setDefaultContentTypeOrder(List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
Sets the content type ordering to apply when performing a call to a
applyOnInteract or
elements method that does not take a content type parameter. |
void |
setDefaultFilterTimeBounds(ILcdTimeBounds aFilterTimeBounds)
Sets the time bounds to restrict to when performing a call to a
applyOnInteract or
elements method that does not take a time bounds parameter. |
Lock |
writeLock() |
allElementsChanged, allElementsRemoved, elementAdded, elementRemoved, elementsAdded, elementsRemoved, getModelMetadata, initializeTransientValues, isClassTraceOn, isTraceOn, setClassTraceOn, setModelDescriptor, setModelDisposer, setModelEncoder, setModelMetadataFunction, setModelReference, setTraceOn
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
addElement, addElements, all, canAddElement, canRemoveElement, elementChanged, elementsChanged, filter, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, removeAllElements, removeElement, removeElements
close
public TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel)
TLcdKML22Model
object based on the given delegate
TLcdKML22ModelTreeNode
. The generated object will flatten the hierarchy of the
ILcdModelTreeNode
interface. This constructor will add listeners to the delegate
model so that all events in the hierarchy become available as model changed events. The
created model will be initialized with the following default content type ordering: aDelegateModel
- The root node of a TLcdKML22ModelTreeNode
hierarchy.public TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel, List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
TLcdKML22Model
object based on the given delegate
TLcdKML22ModelTreeNode
. The generated object will flatten the hierarchy of the
ILcdModelTreeNode
interface. This constructor will add listeners to the delegate
model so that all events in the hierarchy become available as model changed events. Note:
Please call the #dispose method to dispose an instance of this class.aDelegateModel
- The root node of a TLcdKML22ModelTreeNode
hierarchy.aDefaultContentTypeOrder
- a list with sets of KML content types that specifies in which
order the elements of this model should be enumerated when
performing an applyOnInteract
or elements
query.protected void firePropertyChange(PropertyChangeEvent aPropertyChangeEvent)
aPropertyChangeEvent
- a property change eventpublic void removePropertyChangeListener(PropertyChangeListener aListener)
aListener
- a property change listener to removepublic void addPropertyChangeListener(PropertyChangeListener aListener)
aListener
- a property change listener to add to this modelpublic TLcdKML22DynamicModel getDelegateModel()
Returns the TLcdKML22DynamicModel
that this wrapped by this TLcdKML22RenderableModel
TLcdKML22DynamicModel
public List<EnumSet<ELcdKML22ContentType>> getDefaultContentTypeOrder()
public void setDefaultContentTypeOrder(List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
applyOnInteract
or
elements
method that does not take a content type parameter.aDefaultContentTypeOrder
- a list with content types specifying the ordering of the
elements to be applied.public ILcdTimeBounds getDefaultFilterTimeBounds()
applyOnInteract
or elements
method that does not take a content type parameter.public void setDefaultFilterTimeBounds(ILcdTimeBounds aFilterTimeBounds)
applyOnInteract
or
elements
method that does not take a time bounds parameter.aFilterTimeBounds
- The timebounds filter for this model, or null if the timebounds should
not be filtered.public ILcdTimeBounds getTimeBounds(ILcdBounds aSpatialBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, ILcdFilter aElementFilter, boolean aIgnoreUnboundedTimeBounds)
aSpatialBounds
- the spatial bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the
specified content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element
will be selected, otherwise visibility will not be taken into
account.aFilterOnRegion
- region filter - if true
, elements in a non-active
region filter will not be taken into account.aElementFilter
- A custom filter that will be applied on each element.aIgnoreUnboundedTimeBounds
- specifies whether unbounded start or end bounds should be
included in the union (if at least one element is unbounded,
the union bounds will be unbounded).public ILcdBounds getBounds(ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, ILcdFilter aElementFilter)
aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified altitude
mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aElementFilter
- a custom element filter to filter out certain elements from the
bounds calculationpublic int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
false
.aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aFilterOnAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aFilterOnRegion
- the region filter - if true only region active elements will be
selected, otherwise region activity will not be taken into
account.aForceDrawingOrder
- indicates whether the drawing order of overlays should be taken
into account. If true
, objects with a drawing order will
be applied after all other objects, and objects with a higher
drawing order will be applied after objects with a lower drawing
order.aStrictInteract
- if false
, the spatial search may return more elements
than the ones strictly overlapping; if true
, the search
only returns the elements that are overlapping. The latter mode
is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the
given bounds.aPrecisionX
- the precision required in the x dimension, expressed in
model units.aPrecisionY
- the precision required in the y dimension, expressed in
model units.ILcdFunction
has been applied.NullPointerException
- if the specified bounds or the specified function are null
.public int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
false
for an element it was applied
on.aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aFilterOnAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aFilterOnRegion
- the region filter - if true only region active elements will be
selected, otherwise region activity will not be taken into
account.aForceDrawingOrder
- indicates whether the drawing order of overlays should be taken
into account. If true
, objects with a drawing order will
be applied after all other objects, and objects with a higher
drawing order will be applied after objects with a lower drawing
order.aStrictInteract
- if false
, the spatial search may return more elements
than the ones strictly overlapping; if true
, the search
only returns the elements that are overlapping. The latter mode
is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the
given bounds.aPrecisionX
- the precision required in the x dimension, expressed in
model units.aPrecisionY
- the precision required in the y dimension, expressed in
model units.aMinSizeX
- the minimal element size in the x dimension, expressed in
model units.aMinSizeY
- the minimal element size in the y dimension, expressed in
model units.aIncludePoints
- if true
, zero-sized elements (points) are considered as
well, even though they might be smaller than the minimum size.ILcdFunction
has been applied.NullPointerException
- if the specified bounds or the specified function are null
.public Enumeration elements(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder)
aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified altitude
mode will be selected.aFilterOnVisibility
- the visibility filter - if true
, only the visible element
will be selected, otherwise visibility will not be taken into
account.aFilterOnRegion
- region filter - if true
, elements in a non-active region
filter will be skipped.aForceDrawingOrder
- indicates whether the drawing order of overlays should be taken into
account. If true
, objects with a drawing order will be
applied after all other objects, and objects with a higher drawing
order will be applied after objects with a lower drawing order.public ILcdTimeBounds getTimeBounds()
ILcdTimeBounded
ILcdTimeBounds
by which this object is bounded.getTimeBounds
in interface ILcdTimeBounded
ILcdTimeBounds
by which this object is bounded.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModel
false
.applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
aBounds
- the rectangle to test overlap with.aStrictInteract
- if false
, the spatial search may return more elements than the ones strictly
overlapping; if true
, the search only returns the elements that are
overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds.
The return value of the specified function is used as a stop criterion: the spatial query is interrupted
if the function returns false
.aPrecisionX
- the precision required in the x dimension, expressed in model units.
For example, for a cartesian grid system expressed in meters, the values
should be expressed in meters as well, for a geodetic coordinate system the accuracy
values should be expressed in degrees.
The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.ILcdFunction
has been applied.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
ILcd2DBoundsInteractable
false
for an element it was applied on.applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
applyOnInteract2DBounds
in interface ILcd2DBoundsInteractable
aBounds
- the rectangle to test overlap with.aStrictInteract
- if false
, the spatial search may return more elements than the ones strictly
overlapping; if true
, the search only returns the elements that are
overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds.aPrecisionX
- the precision required in the x dimension, expressed in model units.
For example, for a cartesian grid system expressed in meters, the values
should be expressed in meters as well, for a geodetic coordinate system the accuracy
values should be expressed in degrees.
The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.aMinSizeX
- the minimal element size in the x dimension (as in
ILcdBounds.getWidth()
), expressed in model units.
Elements that are smaller than this size will be skipped. This may, for example, be
useful when improving the efficiency of painting elements by skipping elements
that are smaller than some threshold (e.g. one pixel, converted to model units).aMinSizeY
- the minimal element size in the y dimension (as in
ILcdBounds.getHeight()
), expressed in model units.aIncludePoints
- if true
, zero-sized elements (points) are considered as well, even though they
might be smaller than the minimum size.ILcdFunction
has been applied.public Enumeration elements()
ILcdModel
public void dispose()
ALcdModel
finalize
) on this model subsequent to a call to
this method is undefined.
When a model disposer has been provided it is called, otherwise this method does nothing.
When overriding this method it is recommended to call super.dispose()
.
dispose
in interface ILcdModel
dispose
in interface ILcdDisposable
ALcdModel.setModelDisposer(Consumer)
public void addModelListener(ILcdModelListener aModelListener)
ALcdModel
Registers the specified model listener to receive notifications of model changes on this model.
Model changes are sent out when an element has been added, removed or changed. Model changes can be sent out
individually, grouped or silently applied without notifications, depending on the ILcdFireEventMode
that was specified with the change.
In case you need to register a listener which keeps a reference to an object with a shorter life-time than this model,
you can use a ALcdWeakModelListener
instance as model listener.
This implementation calls TLcdModelChangedEventSupport#addModelListener(ILcdModelListener)
.
addModelListener
in interface ILcdModel
addModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void removeModelListener(ILcdModelListener aModelListener)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#removeModelListener(ILcdModelListener)
.
removeModelListener
in interface ILcdModel
removeModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.
If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points)
the return value is unspecified.
It is highly recommended to return an undefined
bounds.
You can create undefined bounds using the default constructors
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public Lock readLock()
readLock
in interface ReadWriteLock
public Lock writeLock()
writeLock
in interface ReadWriteLock
public ILcdModelDescriptor getModelDescriptor()
ALcdModel
ILcdModelDescriptor
providing meta information about this model and
its elements.getModelDescriptor
in interface ILcdModel
getModelDescriptor
in class ALcdModel
ILcdModelDescriptor
of this ILcdModel
. Should not be null
.ALcdModel.setModelDescriptor(ILcdModelDescriptor)
public ILcdModelReference getModelReference()
ALcdModel
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.getModelReference
in interface ILcdModel
getModelReference
in class ALcdModel
ILcdModelReference
of this ILcdModel
.ALcdModel.setModelReference(ILcdModelReference)
public ILcdModelEncoder getModelEncoder()
ALcdModel
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
getModelEncoder
in class ALcdModel
null
otherwise.ALcdModel.setModelEncoder(ILcdModelEncoder)
public boolean canAddElement(Object aElement)
ALcdModel
true
if the specified element can be added to this model, false
otherwise.
Note that this method generally does not validate whether the specified element is expressed in the same model reference as this model. It is the responsibility of the user of this model to make sure this precondition is fulfilled when an element is added to this model.
This implementation always returns false
.
canAddElement
in interface ILcdModel
canAddElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be added to this model, false
otherwise.public void addElement(Object aElement, int aEventMode)
ALcdModel
Models that support this operation may place limitations on what elements may be added to this model. For example,
implementations that are based on a spatial indexing structure will require that elements implement
ILcdBounded
.
When adding an element, the user should make sure that canAddElement(aElement)
holds, and that the
element's geometry is expressed in the same model reference as this model. It is generally undefined what happens
if an invalid element is added.
Implementations of this interface should clearly specify in their documentation any restrictions on what elements
may be added. Although it is unspecified what happens if the preconditions are not met, implementations are
encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException,
ClassCastException, UnsupportedOperationException
), whenever possible.
This implementation always throws an UnsupportedOperationException
.
addElement
in interface ILcdModel
addElement
in class ALcdModel
aElement
- the element to be added to this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public void addElements(Vector aElements, int aEventMode)
ALcdModel
ILcdBounded
. Implementations of this interface should clearly specify in their documentation any
restrictions on what elements may be added.
The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.
The specified elements will be added to this model in the order they are specified in the vector. If an element cannot be added, this method will return at the first failure. Succeeding elements won't be added.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
This implementation iterates over all elements in the specified vector, and calls
addElement(Object, int)
for each element to be added, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
addElements
in interface ILcdModel
addElements
in class ALcdModel
aElements
- the vector of elements to be added to this model.aEventMode
- the mode for sending the model change events This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public boolean canRemoveElement(Object aElement)
ALcdModel
true
if the specified element can be removed from this model, false
otherwise.
Note that this method generally does not check whether the specified element is actually contained in this model.
This implementation always returns false
.
canRemoveElement
in interface ILcdModel
canRemoveElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be removed from this model, false
otherwise.public void removeElement(Object aElement, int aEventMode)
ALcdModel
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
This implementation always throws an UnsupportedOperationException
.
removeElement
in interface ILcdModel
removeElement
in class ALcdModel
aElement
- the element to be removed from this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeElements(Vector aElements, int aEventMode)
ALcdModel
The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.
The specified elements will be removed from this model in the order they are specified in the vector. If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
This implementation iterates over all elements in the specified vector, and calls
removeElement(Object, int)
for each element to be removed, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeElements
in interface ILcdModel
removeElements
in class ALcdModel
aElements
- the vector of elements to be removed from this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeAllElements(int aEventMode)
ALcdModel
If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
This implementation iterates over all elements in the model, and calls
removeElement(Object, int)
for each element to be removed, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeAllElements
in interface ILcdModel
removeAllElements
in class ALcdModel
aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementChanged(Object aElement, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int)
.
elementChanged
in interface ILcdModel
elementChanged
in class ALcdModel
aElement
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementsChanged(Vector aElements, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int)
.
elementsChanged
in interface ILcdModel
elementsChanged
in class ALcdModel
aElements
- the vector of elements that have changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void fireCollectedModelChanges()
ALcdModel
This implementation calls #TLcdModelChangedEventSupport#fireCollectedModelChanges()
.
fireCollectedModelChanges
in interface ILcdModel
fireCollectedModelChanges
in class ALcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)