public class TLcyVerticalViewAddOn extends ALcyAddOn
createAndAddVerticalViewComponent()
.
To store its internal state, the vertical view add-on needs to encode which object was visible in the vertical view. As such, it needs to be able to reference domain objects that are contained in models.
When encoding a reference to a domain object, this add-on passes the model containing the domain object as the parent.
If you are writing your own add-on, and that add-on adds custom models to Lucy,
you will need to add an ALcyWorkspaceObjectCodec
that can encode the state of these domain objects.
Modifier and Type | Field and Description |
---|---|
static TLcyGroupDescriptor |
VERTICAL_VIEW_GROUP_DESCRIPTOR |
Constructor and Description |
---|
TLcyVerticalViewAddOn() |
Modifier and Type | Method and Description |
---|---|
Component |
createAndAddVerticalViewComponent()
Creates and adds a new vertical view component.
|
ALcyVerticalViewComponentFactory |
getVerticalViewComponentFactory()
Returns the factory that is used to create vertical view components.
|
TLcyVerticalViewManager |
getVerticalViewManager()
Returns the
TLcyVerticalViewManager that keeps track of the currently active vertical views. |
void |
plugInto(ILcyLucyEnv aLucyEnv)
Plugs this addon into the given lucy environment.
|
void |
setVerticalViewComponentFactory(ALcyVerticalViewComponentFactory aVerticalViewComponentFactory)
Sets the factory that is used to create vertical view components.
|
void |
unplugFrom(ILcyLucyEnv aLucyEnv)
Unplugs this addon from the given Lucy environment.
|
getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName
public static final TLcyGroupDescriptor VERTICAL_VIEW_GROUP_DESCRIPTOR
public void plugInto(ILcyLucyEnv aLucyEnv)
ALcyAddOn
plugInto
in class ALcyAddOn
aLucyEnv
- The lucy environment to plug into.ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)
public void unplugFrom(ILcyLucyEnv aLucyEnv)
ALcyAddOn
unplugFrom
in class ALcyAddOn
aLucyEnv
- The lucy environment to unplug from.ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)
public Component createAndAddVerticalViewComponent()
factory
and added to an ILcyApplicationPane
.
So after calling this method, the new vertical view is present in the user interface.
The ILcyApplicationPane
for the returned vertical view can be retrieved using
ILcyLucyEnv.getUserInterfaceManager().getApplicationPaneManager()
. To dispose a vertical view,
retrieve its ILcyApplicationPane
and call ILcyApplicationPane.disposeApp()
.factory
.public ALcyVerticalViewComponentFactory getVerticalViewComponentFactory()
setVerticalViewComponentFactory(ALcyVerticalViewComponentFactory)
public void setVerticalViewComponentFactory(ALcyVerticalViewComponentFactory aVerticalViewComponentFactory)
aVerticalViewComponentFactory
- The factory that is used to create vertical view components. Must not
be null
.public TLcyVerticalViewManager getVerticalViewManager()
TLcyVerticalViewManager
that keeps track of the currently active vertical views.TLcyVerticalViewManager
.