HelpSource/Classes/PageLayout.schelp

   1 CLASS:: PageLayout
   2 summary:: a Window with a FlowView on it for use in ObjectGui's MVC model
   3 categories:: GUI
   4 related:: Classes/ObjectGui, Classes/FlowView, Classes/Window, Classes/NotificationCenter
   5
   6 DESCRIPTION::
   7 This class encapsulates the common task of creating a Window, adding a FlowView (CompositeView with a FlowLayout on it).  It also supports the MVC model by registering controllers that are then removed (sent the .remove message) when the Window closes.  Additionally it can resize itself to fit the contents.
   8
   9
  10 CLASSMETHODS::
  11
  12 METHOD:: new
  13 Create a Window with a FlowView on it.  The PageLayout object can be treated like a Window or like a View.
  14
  15 argument:: title
  16 Window title
  17
  18 argument:: bounds
  19 Bounds or nil.  Default of nil will size the window to the entire screen size.  Use .resizeToFit to shrink the window to the content size.
  20
  21 argument:: margin
  22 FlowLayout margin.
  23
  24 argument:: background
  25 Background color
  26
  27 argument:: scroll
  28 boolean: add scroll bars or not.
  29
  30 argument:: front
  31 boolean: whether to immediately display the window, bringing it to the front.  default is true.  You may choose to first add your views to the window and then front it which is useful for large slow GUIs
  32
  33 returns:: a PageLayout
  34
  35
  36 INSTANCEMETHODS::
  37
  38 METHOD:: window
  39 the Window object
  40
  41 returns:: a Window
  42
  43 METHOD:: view
  44 the top most view on the Window
  45
  46 returns:: a View
  47
  48 METHOD:: isClosed
  49 boolean: has the window been closed ?
  50
  51 returns:: boolean
  52
  53 METHOD:: onClose
  54 Just as for Window, this method is called when the PageLayout's window is closed.  The actual Window's onClose method is used to trigger clean up operations, releasing dependencies and will also call this onClose function.
  55
  56 returns:: get/set onClose handler
  57
  58 METHOD:: asView
  59 returns the top view
  60
  61 returns:: a View
  62
  63 METHOD:: asFlowView
  64
  65 argument:: bounds
  66 if bounds are nil then it returns self, as a PageLayout is compatible with FlowView.  If bounds are supplied then a child FlowView is placed and returned
  67
  68 returns:: self or a new FlowView
  69
  70 METHOD:: bounds
  71 inner bounds of the top level view.
  72
  73 returns:: a Rect
  74
  75 METHOD:: asPageLayout
  76 Similar to asFlowView, this message converts nil and various other objects to a PageLayout. This is already a PageLayout, so it returns self.
  77
  78 argument:: name
  79 Ignored. If the receiver had been nil then the name would be the Window name.
  80
  81 argument:: bounds
  82 Ignored. Would have been used to size the PageLayout
  83
  84 returns:: self
  85
  86 METHOD:: startRow
  87 compatible with FlowView
  88
  89 returns:: self
  90
  91 METHOD:: indentedRemaining
  92 compatible with FlowView
  93
  94 returns:: self
  95
  96 METHOD:: checkNotClosed
  97 isClosed.not
  98
  99 returns:: boolean
 100
 101 METHOD:: front
 102 bring Window to the front
 103
 104 returns:: self
 105
 106 METHOD:: hide
 107 Hide window
 108
 109 returns:: self
 110
 111 METHOD:: show
 112 Show the window if it was previously hidden.
 113
 114 returns:: self
 115
 116 METHOD:: close
 117 Close the window, releasing any dependencies and calling the onClose handler.
 118
 119 returns:: self
 120
 121 METHOD:: refresh
 122 Refresh the top level view
 123
 124 returns:: self
 125
 126 METHOD:: background
 127 set background color of top level view
 128
 129 argument:: c
 130 color
 131
 132 returns:: self
 133
 134 METHOD:: removeOnClose
 135 Register an object, usually a ObjectGui subclass or an Updater so that when the Window closes the .remove message will be sent to it. This will cause the object to release its dependencies on its Model.  This means the ObjectGui (or other controller object) will stop getting update messages and will stop trying to update the View which has just been closed along with the Window.  It also means that if there is no link to the Model and no longer any Views that held links to the controller object, that the controller is now unreferenced and will be garbage collected.
 136
 137 argument:: dependant
 138 the object that wishes to be sent .remove on closing the window
 139
 140 returns:: self
 141
 142 METHOD:: resizeToFit
 143 Resize the top FlowView to fit its contents and then resize the Window to fit that.=
 144
 145 argument:: reflow
 146 boolean: FlowView can relay all of its child views in cases where the bounds have changed or views have been removed.  This puts them all back in place one by one for the updated bounds.  So this may result in smaller over all bounds, after which the window is shrunk.
 147
 148 argument:: center
 149 boolean: after resizing, re-center the window in the screen.
 150
 151 returns:: self
 152
 153 METHOD:: reflowAll
 154 see FlowView reflowAll
 155
 156 returns:: self
 157
 158 METHOD:: fullScreen
 159 go Full screen
 160
 161 returns:: self
 162
 163 METHOD:: endFullScreen
 164 end full screen
 165
 166 returns:: self
 167
 168 subsection::FlowView extensions
 169
 170 METHOD:: flow
 171 Place a new FlowView on the window
 172
 173 argument:: func
 174 A handler that recieves the new FlowView as argument
 175
 176 argument:: bounds
 177 Bounds fo the FlowView
 178
 179 returns:: (returnvalue)
 180
 181 METHOD:: vert
 182 (describe method here)
 183
 184 argument:: func
 185 (describe argument here)
 186
 187 argument:: bounds
 188 (describe argument here)
 189
 190 argument:: spacing
 191 (describe argument here)
 192
 193 returns:: (returnvalue)
 194
 195 METHOD:: horz
 196 (describe method here)
 197
 198 argument:: func
 199 (describe argument here)
 200
 201 argument:: bounds
 202 (describe argument here)
 203
 204 argument:: spacing
 205 (describe argument here)
 206
 207 returns:: (returnvalue)
 208
 209 METHOD:: comp
 210 (describe method here)
 211
 212 argument:: func
 213 (describe argument here)
 214
 215 argument:: bounds
 216 (describe argument here)
 217
 218 returns:: (returnvalue)
 219
 220 METHOD:: scroll
 221 (describe method here)
 222
 223 argument::  ... args
 224 (describe argument here)
 225
 226 returns:: (returnvalue)
 227
 228
 229 EXAMPLES::
 230
 231 code::
 232 PageLayout.new
 233 ::