Data Model version 2.1.2
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: Layout

Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class memops.api.Implementation.MemopsRoot
Main key: name
Mandatory Attributes: name
Partitions Children: True
Known Subclasses: None
Children:
link axisGroups to class AxisGroup
link marks to class Mark
link panels to class AbstractPanel
link parameters to class LayoutParameter
link rulers to class Ruler
link windowPanelGroups to class WindowPanelGroup
Constructor: newObj = Layout( memopsRoot,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
helpUrl Url 0..1 Url of help tect  
isActive Boolean 1..1 Is layout active?  
isDefault Boolean 1..1 Is layout the default?  
keywords Line 0..* Keywords describing layout - e.g. for classification.  
name Line 1..1  
rank PositiveInt 1..1 Priority order of layout, e.g. for ordering in menus  
shortcut Word 0..1 Text for keyboard shortcut  
showWindowDepth Boolean 1..1 Show window depth?  
showWindowLabels Boolean 1..1 Show window labels?  
showWindowMidpoint Boolean 1..1 Show mark at window midpoint?  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout 0..* AnalysisLayouts containg current data object for Layout  
axisGroups AxisGroup 0..* (Child link). child link to class AxisGroup  
marks Mark 0..* (Child link). child link to class Mark  
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
panels AbstractPanel 0..* (Child link). child link to class AbstractPanel  
parameters LayoutParameter 0..* (Child link). child link to class LayoutParameter  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
rulers Ruler 0..* (Child link). child link to class Ruler  
windowPanelGroups WindowPanelGroup 0..* (Child link). child link to class WindowPanelGroup  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
helpUrl
getHelpUrl Url -
setHelpUrl - Url
isActive
getIsActive Boolean -
setIsActive - Boolean
isDefault
getIsDefault Boolean -
setIsDefault - Boolean
keywords
getKeywords Line Tuple -
setKeywords - Line List
addKeyword - Line
removeKeyword - Line
name
getName Line -
setName - Line
rank
getRank PositiveInt -
setRank - PositiveInt
shortcut
getShortcut Word -
setShortcut - Word
showWindowDepth
getShowWindowDepth Boolean -
setShowWindowDepth - Boolean
showWindowLabels
getShowWindowLabels Boolean -
setShowWindowLabels - Boolean
showWindowMidpoint
getShowWindowMidpoint Boolean -
setShowWindowMidpoint - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisLayouts
getAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set -
setAnalysisLayouts - ccpnmr.api.AnalysisV3.AnalysisLayout Set
sortedAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout List -
findFirstAnalysisLayout ccpnmr.api.AnalysisV3.AnalysisLayout keyword=value pairs
findAllAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set keyword=value pairs
axisGroups
getAxisGroups AxisGroup Set -
sortedAxisGroups AxisGroup List -
findFirstAxisGroup AxisGroup keyword=value pairs
findAllAxisGroups AxisGroup Set keyword=value pairs
marks
getMarks Mark Set -
sortedMarks Mark List -
findFirstMark Mark keyword=value pairs
findAllMarks Mark Set keyword=value pairs
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
panels
getPanels AbstractPanel Set -
sortedPanels AbstractPanel List -
findFirstPanel AbstractPanel keyword=value pairs
findAllPanels AbstractPanel Set keyword=value pairs
parameters
getParameters LayoutParameter Set -
sortedParameters LayoutParameter List -
findFirstParameter LayoutParameter keyword=value pairs
findAllParameters LayoutParameter Set keyword=value pairs
parent
getParent memops.api.Implementation.MemopsRoot -
rulers
getRulers Ruler Set -
sortedRulers Ruler List -
findFirstRuler Ruler keyword=value pairs
findAllRulers Ruler Set keyword=value pairs
windowPanelGroups
getWindowPanelGroups WindowPanelGroup Set -
sortedWindowPanelGroups WindowPanelGroup List -
findFirstWindowPanelGroup WindowPanelGroup keyword=value pairs
findAllWindowPanelGroups WindowPanelGroup Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Layout memops.api.Implementation.MemopsRoot, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
newAxisGroup AxisGroup ...
newLayoutParameter LayoutParameter name, ...
newMark Mark ...
newModulePanel ModulePanel moduleCode, ...
newRuler Ruler axisCode, position, unit, ...
newWindowPanel1d WindowPanel1d moduleCode, ...
newWindowPanelGroup WindowPanelGroup ...
newWindowPanelNd WindowPanelNd moduleCode, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2011-11-16-17:07:15_00011

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: memops.api.Implementation.MemopsRoot.currentLayout
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:09 2014    from data model package  ccpnmr.api.AnalysisLayout.Layout   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk