public interface IlpBackgroundSupport
IlpViewsView
s to handle the background support needs of
background based components such as the IlpNetwork
and
IlpEquipment
.
The functions in this interface can be called by the view, the controller, or an interactor.
IlpBackgroundFactory
,
IlpBackgroundListener
Modifier and Type | Method and Description |
---|---|
void |
addBackground(URL backgroundURL)
Adds the background pointed by the provided
URL as the last
background. |
void |
addBackground(URL backgroundURL,
IlpBackground background,
int index)
Adds the background specified in the
URL using the the provided
IlpBackground at the specified index. |
void |
addBackground(URL backgroundURL,
int index)
Adds the background pointed by the provided
URL at the specified index. |
void |
addBackgroundListener(IlpBackgroundListener listener)
Allows individuals to add an
IlpBackgroundListener to this
IlpBackgroundSupport . |
void |
addBackgrounds(List backgroundURLs)
Adds the provided backgrounds.
|
IlpBackgroundFactory |
getBackgroundFactory(String extension)
Returns the
IlpBackgroundFactory for the given extension. |
IlpBackground |
getBackgroundInstance(URL backgroundURL)
Returns the
IlpBackground instance associated with the
URL provided. |
List |
getBackgrounds()
Returns a read-only List of
URL instances in the same order as
they were indexed. |
IlpViewsView |
getView()
Returns the
IlpViewsView that this background support is
associated with. |
void |
moveBackground(URL backgroundURL,
int index)
Allows individuals to move the background specified by the provided URL to
the index provided.
|
void |
registerBackgroundFactory(String extension,
IlpBackgroundFactory factory)
Registers the provided
IlpBackgroundFactory for the given
extension. |
void |
reloadBackground(URL backgroundURL)
Reloads the background pointed to by the provided URL.
|
void |
reloadBackgrounds()
Reloads all the background.
|
void |
removeBackground(URL backgroundURL)
Removes the background pointed to by the provided
URL . |
void |
removeBackgroundListener(IlpBackgroundListener listener)
Allows individuals to removed an
IlpBackgroundListener to from
IlpBackgroundSupport . |
void |
removeBackgrounds()
Removes all backgrounds.
|
void |
setView(IlpViewsView view)
Associates this background support with the provided view.
|
void addBackground(URL backgroundURL) throws IlpBackgroundHandlingException
URL
as the last
background.backgroundURL
- the URL
of the background to be addedIlpBackgroundHandlingException
- in case a problem occurs when adding
background for the provided URL
.void addBackground(URL backgroundURL, int index) throws IlpBackgroundHandlingException
URL
at the specified index.backgroundURL
- the URL
of the background to be addedindex
- the index where to add the backgroundIlpBackgroundHandlingException
- in case a problem occurs when adding
background for the provided URL
at the given index.void addBackground(URL backgroundURL, IlpBackground background, int index) throws IlpBackgroundHandlingException
URL
using the the provided
IlpBackground
at the specified index.backgroundURL
- the URL
of the background to be addedbackground
- the IlpBackground instance to be usedindex
- the index where to add the backgroundIlpBackgroundHandlingException
- in case a problem occurs when adding
background for the provided URL
and IlpBackground
.void removeBackground(URL backgroundURL) throws IlpBackgroundHandlingException
URL
.backgroundURL
- the URL of the background of interestIlpBackgroundHandlingException
- in case a problem occurs when
removing the IlpBackground
associated with the provide
URL
.void removeBackgrounds() throws IlpBackgroundHandlingException
IlpBackgroundHandlingException
- in case a problem occurs when
removing all the backgrounds.void reloadBackground(URL backgroundURL) throws IlpBackgroundHandlingException
backgroundURL
- the URL that points to a given background.IlpBackgroundHandlingException
- in case a problem occurs when
reloading the provided URL
.void reloadBackgrounds() throws IlpBackgroundHandlingException
IlpBackgroundHandlingException
- in case a problem occurs when
reloading all the backgrounds.List getBackgrounds()
URL
instances in the same order as
they were indexed.URL
instances in the same order as they
were indexedvoid addBackgrounds(List backgroundURLs) throws IlpBackgroundHandlingException
backgroundURLs
- a List of URL
instancesIlpBackgroundHandlingException
- in case a problem occurs when
adding all the backgrounds.IlpBackground getBackgroundInstance(URL backgroundURL) throws IlpBackgroundHandlingException
IlpBackground
instance associated with the
URL
provided.backgroundURL
- the URL
of interest.IlpBackground
instance that represents the provided URL
IlpBackgroundHandlingException
- in case a problem occurs when
obtaining the IlpBackground
instance for the provide
URL
.void setView(IlpViewsView view) throws IlpBackgroundHandlingException
If a null value is passed as the view, this background support
disengages support for its previous IlpViewsView
.
view
- the IlpViewsView of interest.IlpBackgroundHandlingException
- in case a problem occurs when
setting IlpViewsView
.IlpViewsView getView()
IlpViewsView
that this background support is
associated with.IlpViewsView
that this background support is
associated with.IlpBackgroundFactory getBackgroundFactory(String extension)
IlpBackgroundFactory
for the given extension.extension
- the extension that should specified in the form: "gif", "png"...IlpBackgroundFactory
registered for the given extension or null
if no factory has been registered for it.void registerBackgroundFactory(String extension, IlpBackgroundFactory factory) throws IlpBackgroundHandlingException
IlpBackgroundFactory
for the given
extension.
If a null value is passed as the factory, the factory is removed from the list of registered factories.
If a this method is called multiple times with different instances of factories, the last instance provided will be the one into effect.
extension
- the extension that should specified in the form: "gif", "png"...factory
- the IlpBackgroundFactory
to be used for the given
extension or nullIlpBackgroundHandlingException
- in case a problem occurs when
registering the IlpBackgroundFactory
for the given extension.void addBackgroundListener(IlpBackgroundListener listener)
IlpBackgroundListener
to this
IlpBackgroundSupport
.listener
- IlpBackgroundListener
to be notified of changes.void removeBackgroundListener(IlpBackgroundListener listener)
IlpBackgroundListener
to from
IlpBackgroundSupport
.listener
- IlpBackgroundListener
to be removed.void moveBackground(URL backgroundURL, int index) throws IlpBackgroundHandlingException
backgroundURL
- the URL
of the background of interest.index
- the index where the background should now be located.IlpBackgroundHandlingException
- in case a problem occurs when moving
the background.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.