public interface LayoutCollection extends TaggedObjectCollection
BasePart
Modifier and Type | Interface and Description |
---|---|
static class |
LayoutCollection.CreateSplitScreenLayoutAndNamedViewsData
This class holds the data returned from
createSplitScreenLayoutAndNamedViews(java.lang.String, java.lang.String) |
TaggedObjectCollection.Iterator
Modifier and Type | Method and Description |
---|---|
void |
changeLayout(Layout layout)
Sets the given layout as current layout
License requirements: None. |
void |
changeLayoutWithOptions(Layout layout,
boolean removeOldLayoutCache,
boolean ignoreNewLayoutCache)
Sets the given layout as current layout and optionally removes the old and/or new layout caches
License requirements: None. |
Layout |
create(String name,
LayoutDefinition layoutArrangement,
boolean fitAllViews)
Creates a layout using an
LayoutDefinition . |
LayoutCollection.CreateSplitScreenLayoutAndNamedViewsData |
createSplitScreenLayoutAndNamedViews(String leftViewName,
String rightViewname)
This method creates a layout with two modeling views.
|
Layout |
current()
Returns the current layout of the part.
|
void |
destroySplitScreenLayoutAndNamedViews(Layout layout)
This method destroys the split screen layout along with the views
that are there in it
License requirements: None. |
Layout |
findObject(String journalIdentifier)
Finds the
Layout with the given identifier as recorded in a journal. |
LayoutDefinition |
newLayoutDefinition(LayoutDefinition.ArrangementType arrangement)
Constructs a
LayoutDefinition object to be used to create a layout. |
void |
renameViewsInSplitScreenLayout(Layout layout,
String leftViewName,
String rightViewName)
Using given names renames the views in split screen layout.
|
_find_next, iterator
Layout create(String name, LayoutDefinition layoutArrangement, boolean fitAllViews) throws NXException, RemoteException
name
- Name of layoutlayoutArrangement
- Arrangement and view location informationfitAllViews
- Flag that indicates for the system to perform a fit before
displaying the view. Otherwise the system displays the view
at the scale at which it was last saved.NXException
RemoteException
LayoutDefinition newLayoutDefinition(LayoutDefinition.ArrangementType arrangement) throws NXException, RemoteException
LayoutDefinition
object to be used to create a layout. If a layout is not created
using the created definition object, the client is responsible for deleting it.
arrangement
- Arrangement typeNXException
RemoteException
Layout current() throws NXException, RemoteException
NXException
RemoteException
Layout findObject(String journalIdentifier) throws NXException, RemoteException
Layout
with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of
the software. However newer versions of the software should find the same object when
FindObject is passed older versions of its journal identifier. In general, this method
should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier
- Identifier to be foundNXException
RemoteException
LayoutCollection.CreateSplitScreenLayoutAndNamedViewsData createSplitScreenLayoutAndNamedViews(String leftViewName, String rightViewname) throws NXException, RemoteException
leftViewName
- name for the left viewrightViewname
- name for the right viewNXException
RemoteException
void destroySplitScreenLayoutAndNamedViews(Layout layout) throws NXException, RemoteException
layout
- LayoutNXException
RemoteException
void changeLayout(Layout layout) throws NXException, RemoteException
layout
- LayoutNXException
RemoteException
void renameViewsInSplitScreenLayout(Layout layout, String leftViewName, String rightViewName) throws NXException, RemoteException
layout
- LayoutleftViewName
- name for the left viewrightViewName
- name for the right viewNXException
RemoteException
void changeLayoutWithOptions(Layout layout, boolean removeOldLayoutCache, boolean ignoreNewLayoutCache) throws NXException, RemoteException
layout
- LayoutremoveOldLayoutCache
- Flag to indicate if the current layout's cache should be removedignoreNewLayoutCache
- Flag to indicate if the new layout's cache should be used or removedNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.