AttributeStep

LabelButtonAction

Attributes

AcceptImmediately ChoiceList ModeAlteration ShouldUpdateNextButton StepControl TargetAttribute

Fields

instance AttributeStep tag;
         prompt: nilObject;
targetAttribute: nilOperation;
     choiceList: nilObject;
       stepInfo: nilObject;
    stepControl: nilObject;
 modeAlteration: 0;
   blankSetCaps: false;
   firstSetCaps: false;
 useLabelButton: false;
 usePrefixField: false;
acceptImmediately: false;
  checkEditList: false;
    doneIfEmpty: false;
dontMoveControl: false;
shouldUpdateNextButton: false;
end instance;

 
 
Define Class AttributeStep;
    inherits from Object;

    field prompt:               Text;
        // text describing step;
        // if 1 step is displayed, prompt appears above field or control
        // if 2 steps are displayed, prompt is label for button to left of field or control
    field targetAttribute:      OperationNumber, getter, setter;
        // used by TargetAttribute attribute
    field choiceList:           ObjectList, getter, setter;
        // used by ChoiceList attribute
    field stepInfo:             Text;       
        // help info for this step (can be nilObject)
    field stepControl:          Object, getter, setter;
        // used by StepControl attribute
    field modeAlteration:       UnsignedShort, getter;
        // specify which keyboard panel to use
    field blankSetCaps:         Boolean;    
        // set keyboard to caps after space characters for this step
    field firstSetCaps:         Boolean;    
        // set caps mode of keyboard at the beginning of this step
    field useLabelButton:       Boolean;    
        // if set, put prompt text into button name, and make button visible
    field usePrefixField:       Boolean;    
        // if set, show prefix field before bottom field (usually false, used by international phone numbers)
    field acceptImmediately:    Boolean, getter;    
        // accept value when field is deactivated, so other visible fields can react
    field checkEditList:        Boolean;    
        // if set, check if we should resort iCurrentEditList (usually false, used by word lists book)
    field doneIfEmpty:          Boolean;    
        // if set, show 'done' button if value or NextEditSteps is nil
    field dontMoveControl:      Boolean;    
        // if set, do not change origin of stepControl to match position of label button (almost always false)
    field shouldUpdateNextButton:       Boolean, getter, setter;
        // used by UpdateNextButton attribute

    attribute ChoiceList: ObjectList;
        // list of text objects for use in auto-completion
    operation LabelButtonAction();
        // called by system when attribute window button for this step is pressed;
        // if StepControl is a choice box, calls TapCenter on it, otherwise does nothing;
        // activating attribute window's text field is handled by attribute window;
        // override occasionally to perform some action other than activating text field or tapping choice box;
    attribute TargetAttribute: OperationNumber, safe;
        // operation number of attribute that this step edits
    attribute StepControl: Object;
        // control to use instead of text field for this step (usually nilObject)
    attribute ModeAlteration: UnsignedShort, readOnly;
    attribute ShouldUpdateNextButton: Boolean;
        // if set, update the next/done button (the target changing may have changed the step list)
    attribute AcceptImmediately: Boolean, readOnly;
        // accept value when field is deactivated, so other visible fields can react
end class;