[operations] [attributes] [fields] [template] [definition]
[implementation] [documentation]
To use the search tool you need to use a browser which supports JAVA (c)

[next] [prev] [superclass] [next peer] [prev peer] [subclass] [index] [hierarchy]

Folder

inherits from Card
inherits from HasContentList
inherits from PeopleListTarget
inherits interface from HasEntity

Object <- Viewable <- Card <- Folder



Operations

Get list of all operations

CalcInsidePart
DefaultScene
Finalize
GoToVia
MatchCard
MoveToStack
PlaceInFileCabinet
Render
SearchForObject


Attributes

Get list of all attributes

AcceptAnything
AcceptReceived
CanMoveFolder
CanSortFolder
ContentDescription
DateToMatch
Entity
Entity
ImageToMatch
Name
PersonToMatch
ShouldMatchDate
ShouldMatchImage
ShouldMatchPerson
ShouldMatchText
SmallCardImage
Subject
TextToMatch
TypeDescription
UseMonth
UseSentReceived


Fields

Field Type
Viewable: superview: Viewable
relativeOrigin: Dot
contentSize: Dot
viewFlags: Flags
labelStyle: TextStyle
color: Unsigned
altColor: Unsigned
shadow: Shadow
sound: Playable
Card: prototypeForm: Form
stack: StackOfCards
noEnvelope: Boolean
sentFlag: Boolean
isEnvelope: Boolean
isStationery: Boolean
substitute: Boolean
suppressCardData: Boolean
autoAddress: Boolean
wasSeen: Boolean
autoPencil: Boolean
noAutoKeyboard: Boolean
tempTOCEntry: Boolean
rightPageEntry: Boolean
noDrawing: Boolean
dontPurge: Boolean
locked: Boolean
isConfirmed: Boolean
shrinkToFit: Boolean
noFileAfterSend: Boolean
noSubstituteCard: Boolean
isReadOnly: Boolean
dontAppearInLog: Boolean
deliveryReport: Boolean
createdPostR1: Boolean
onePagePerCard: Boolean
HasContentList: contentList: StackOfCards
Folder: acceptAnything: Boolean
useSentReceived: Boolean
acceptReceived: Boolean
useMonth: Boolean
canMoveFolder: Boolean
canSortFolder: Boolean
shouldMatchDate: Boolean
shouldMatchImage: Boolean
shouldMatchPerson: Boolean
shouldMatchText: Boolean
personToMatch: FullContact
textToMatch: Text
imageToMatch: Object
dateToMatch: Signed
folderTray: Object


Instance template

instance Folder tag;
 relativeOrigin: <0.0,0.0>;
    contentSize: <0.0,0.0>;
      viewFlags: 0x00000000;
     labelStyle: nilObject;
          color: 0;
       altColor: 0;
         shadow: nilObject;
          sound: nilObject;
  prototypeForm: nilObject;
          stack: nilObject;
     noEnvelope: false;
       sentFlag: false;
     isEnvelope: false;
   isStationery: false;
     substitute: false;
suppressCardData: false;
    autoAddress: false;
        wasSeen: false;
     autoPencil: false;
 noAutoKeyboard: false;
   tempTOCEntry: false;
 rightPageEntry: false;
      noDrawing: false;
      dontPurge: false;
         locked: false;
    isConfirmed: false;
    shrinkToFit: false;
noFileAfterSend: false;
noSubstituteCard: false;
     isReadOnly: false;
dontAppearInLog: false;
 deliveryReport: false;
  createdPostR1: false;
 onePagePerCard: false;
    contentList: nilObject;
 acceptAnything: false;
useSentReceived: false;
 acceptReceived: false;
       useMonth: false;
  canMoveFolder: false;
  canSortFolder: false;
shouldMatchDate: false;
shouldMatchImage: false;
shouldMatchPerson: false;
shouldMatchText: false;
  personToMatch: nilObject;
    textToMatch: nilObject;
   imageToMatch: nilObject;
    dateToMatch: 0;
     folderTray: nilObject;
end instance;

Class definition

Define Class Folder;
    inherits from Card;
    inherits from HasContentList;
    inherits interface from HasEntity;
    inherits from PeopleListTarget;

    field acceptAnything:       Boolean, getter, setter;
        // if set, accept anything
    field useSentReceived:      Boolean, getter, setter;
        // if set, use sent/received criteria, otherwise, ignore it
    field acceptReceived:       Boolean, getter, setter;
        // if set, accepts received cards; if clear, sent cards
    field useMonth:             Boolean, getter, setter;
        // if set, filter according to the date by months
    field canMoveFolder:        Boolean, getter, setter;
        // if set, can drag this one
    field canSortFolder:        Boolean, getter, setter;
        // if set, allow setting of sort criteria
    field shouldMatchDate:      Boolean, getter, setter;
    field shouldMatchImage:     Boolean, getter, setter;
    field shouldMatchPerson:    Boolean, getter, setter;
    field shouldMatchText:      Boolean, getter, setter;
    field personToMatch:        FullContact;
    field textToMatch:          Text, getter, setter;
    field imageToMatch:         Object, weak, getter, setter;
    field dateToMatch:          Signed, getter, setter;
    field folderTray:           Object, weak;
        // obsolete: ignored (source code says otherwise)

    overrides Entity;
    overrides SetEntity;
    operation PlaceInFileCabinet(folder: Object), safe, common;

    attribute AcceptAnything: Boolean;
    attribute UseSentReceived: Boolean;
    attribute AcceptReceived: Boolean;
    attribute UseMonth: Boolean;
    attribute CanMoveFolder: Boolean;
    attribute CanSortFolder: Boolean;
    
    attribute DateToMatch: Signed;
    attribute ImageToMatch: Object;
    attribute PersonToMatch: FullContact;
    attribute TextToMatch: Text;
    attribute ShouldMatchDate: Boolean;
    attribute ShouldMatchImage: Boolean;
    attribute ShouldMatchPerson: Boolean;
    attribute ShouldMatchText: Boolean;

    overrides CalcInsidePart;
    overrides SmallCardImage;
    overrides DefaultScene;
    overrides ContentDescription;
    overrides Subject;
    overrides TypeDescription;
    overrides Finalize;
        // remove self from iFolderChoiceList if present.
        
    overrides Render;

    overrides SetName;
        // updates reinstall entries of cards since folder name affects install flags
    overrides MoveToStack;
        // updates reinstall entries of cards in folder since drawer stack name affects install flags

    overrides GoToVia;
        // if this is a folder in the file cabinet, installs self in file cabinet's folder scene
    overrides SearchForObject;
        // checks if name matches, and checks each card in list

    operation MatchCard(card: Object): Boolean;
end class;