Announcement

Abort AlreadyInCarousel Announce AnnounceQuietly DoInstallAnnouncement DoRemoveAnnouncement

Present RegisterWithCarousel ReplaceTextData Retract RetractList RetractWithoutHiding

Attributes

DataStore DataStore DestroyOnRetract DisplayOnce HasCloseBox Info KeepFrontmost

OnScreen PersistentAnnouncement PublicAddress Sound Stamp TextMapping Urgent

Fields

instance Announcement tag;
    displayOnce: false;
         urgent: false;
        noStamp: false;
destroyOnRetract: false;
        mapText: false;
    hasCloseBox: false;
        isError: false;
      presented: false;
  keepFrontmost: false;
    surviveBoot: false;
     persistent: false;
announcedQuietly: false;
           info: nilObject;
          stamp: nilObject;
          sound: nilObject;
  publicAddress: nilObject;
end instance;

Define Class Announcement;
    inherits from Object, TextContainer;

    field displayOnce:      Boolean, getter, setter;
        // if set, announcement is not put in carousel when it is retracted
    field urgent:           Boolean, getter, setter;
    field noStamp:          Boolean;
    field destroyOnRetract: Boolean, getter, setter;
    field mapText:          Boolean;
        // if set, 'info' should contain a Text object with parameters to be mapped;
        // TextMapping returns the TextMapping used to map the text
    field hasCloseBox:      Boolean, getter, setter;
    field isError:          Boolean;
    field presented:        Boolean;
    field keepFrontmost:    Boolean, getter, setter;
    field surviveBoot:      Boolean;
    field persistent:       Boolean;
    field announcedQuietly: Boolean;
    field info:             Object, getter;
        // text of the announcement
    field stamp:            Viewable, getter, setter;
    field sound:            Sound, getter;
        // sound that is played when the announcement is made
    field publicAddress: PublicAddress, getter;
        // which public address to use for the announcement
    
    attribute Info: Object;
    attribute Stamp: Viewable;
    attribute PublicAddress: PublicAddress;

    // options for the Announcement during _Announce
    attribute DestroyOnRetract: Boolean;
    attribute DisplayOnce: Boolean;
    attribute KeepFrontmost: Boolean;
    attribute Urgent: Boolean;
    attribute HasCloseBox: Boolean;
    attribute PersistentAnnouncement: Boolean;
    attribute Sound: Playable, readOnly;
    attribute TextMapping: TextMapping, readOnly;
        // returns iStandardTextMapping

    operation Abort(), noFail;
        // hitting stop button calls this method
    operation Announce(), noFail;
    operation AnnounceQuietly(), noFail;
        // install in carousel, but don't present the announcement window
    operation Present(), noFail;
        // display an already-announced announcement
    operation Retract(), noFail;
    operation RetractWithoutHiding();
        // retracts an announcement without automatically hiding the window that's displayed
    intrinsic RetractList(list: Object);
    attribute OnScreen: Boolean, readOnly;

    overrides DataStore, SetDataStore, ReplaceTextData;
    
    operation DoInstallAnnouncement(quietly: Boolean);
    operation DoRemoveAnnouncement();
        // Bottleneck functions used by the announcer.
        // Some packages want to intercept system announcements, so all
        // calls to these two functions go through the iAnnouncer indexical.

    operation AlreadyInCarousel(carousel: Object): Boolean, intrinsic;
    operation RegisterWithCarousel(), intrinsic;
    
end class;