HelpSource/Classes/SCContainerView.schelp

   1 class:: SCContainerView
   2 summary:: An abstract superclass for container views
   3 categories:: GUI
   4 related:: Classes/CompositeView, Classes/HLayoutView, Classes/VLayoutView, Classes/ScrollView, Classes/SCTopView, Classes/SCScrollTopView
   5
   6 description::
   7 Users will not normally directly create instances of ContainerView, but only use it through its subclasses. It provides the basic mechanisms for container views of various kinds, which are used for placing and grouping widgets in a window.
   8
   9
  10
  11 subsection:: Some Important Issues Regarding ContainerView
  12
  13 Container views are meant for placing and grouping child views and widgets. While they accept key actions, many do not accept mouse clicks or drags. The exception is SCTopView and its subclasses.
  14
  15 classmethods::
  16
  17
  18 instancemethods::
  19
  20 subsection:: Accessing Instance and Class Variables
  21
  22 method:: decorator
  23 An automatic layout management for a container. Currently the only one existing is link::Classes/FlowLayout::.
  24 note::Crucial Library also has a useful layout tool called GridLayout.::
  25 argument:: arg1
  26
  27 method:: addFlowLayout(margin, gap)
  28 A convenience utility which sets decorator to link::Classes/FlowLayout:: and returns the decorator. See link::Classes/FlowLayout:: for examples.
  29 argument:: margin
  30 An instance of link::Classes/Point::.
  31 argument:: gap
  32 An instance of link::Classes/Point::.
  33
  34 method:: children
  35 An array containing all the views (children) contained in the the container.
  36
  37
  38
  39 subsection:: Adding and Removing Subviews
  40
  41 method:: add
  42 Adds a view to children. The placement of the child view will depend on the the decorator, and the child's bounds. Normally you don't need to call this directly, since subviews call it automatically when you create them.
  43 argument:: child
  44
  45 method:: removeAll
  46 Removes all children from the view.
  47
  48
  49
  50 subsection:: Subclassing and Internal Methods
  51
  52 The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.
  53
  54 method::init
  55 argument:: argParent
  56 argument:: argBounds
  57
  58 method:: prRemoveChild
  59 Private method.
  60 argument:: child
  61
  62 method:: prClose
  63 Private method.