Class - Event_

Public Methods
Public Method Details
Private Methods
State

Inheritance - ::gui::Event_ ::mps::Event_

Public Methods

(top level)

create key type obj y args   Create a gui::Event_ object and display a view of it on the current canvas (procedure)
destroy     Delete a gui::Event_ object and undisplay any views
deploy y args   A view of the object is displayed and sub-objects are also deployed
recall     Any view is undisplayed and sub-objects are also recalled
move mode args   Move a view of the Event object around on a drawing canvas
optget option   Optain a value for the specified graphical option
optmod args   Set a value for a graphical option, or obtain option list(s), do arch check, history, update
update args  
select args   Show the object as selected
fade     Show the current view of the object as faded
unfade     Undo the effects of 'fade'

(low level)

activate sbtag args  
addSelectBoxes     Show selection boxes on the current view of the object
attachMsg msg  
attachPin pin  
attachSeg seg  
buildTree top avoid   Build the architectural state and graphical defaults of the object into a DOM tree
buildTree_gui top view   Build the graphical values of the specified view into a DOM tree
checkConfig vname  
constructor type obj args  
copy    
cut    
deactivate sbtag args  
delete args   Destroy the object
deleteSelectBoxes     Undo the effects of 'addSelectBoxes'
destructor    
display {y auto} args   Display a graphical view of the object on the current canvas
dump    
findNeighbor dir args  
getCanvas    
getCname    
getCommand mode   Returns a string that can be used to re-create/display/copy the object as it exists now
getCoord req  
getGroupTag    
getMsgs args  
getNext    
getOptions args   Return information about the options for this object
getPcode    
getPrev    
getProperties     (procedure)
getPropertyList    
highlight mode  
invalidate    
isEditable     (procedure)
isOkToDelete    
moveDist moveit xDist yDist  
optset args  
paste {mode obj}  
raise     Raise the view of the object in the canvas display order
receive    
resize sbtag mode args   Move the event due to movement of a selectbox (no resizing of events)
slide mode args   Slide a view of the Event object on the rule, other events slide along
unattachMsg {msg {}}  
unattachPin    
unattachSeg    
undisplay {view {}}   Undisplay a view of the object
unselect    

Public Method Details
activate
addSelectBoxes
  Determine locations for selection boxes and then create the selectbox objects.
attachMsg
attachPin
attachSeg
buildTree
  The architectural state and initial graphical state of the Event object are grafted onto the DOM tree element indicated.
 
top
  a pointer to a tree element
buildTree_gui
  The current graphical state of the specified view is grafted onto the DOM tree element indicated.
 
top
  a pointer to a tree element
 
view
  the View (Edit sheet) from which to obtain the view of the Event object
checkConfig
  This code fragment will be called when a command is executed. Keep corresponding item on the canvas in sync with the architecture state change.
constructor   type obj ?<options>?
  Use the itcl::class definition to create an Event object.
copy
create   key type obj y ?<options>?
  A gui::Event_ object is created with name <key> and type <type>. The initial placement is on the owning rule at y-coordinate <y>. A view of the object is shown on the current canvas.
  Graphical options can be passed in which will be used as default values for all subsequent views of the object which are displayed on any canvas. (Any graphical options not specified will use the class values set up during program start up.)
  The command is posted to the Hist/Undo stacks.
 
key
  used to create a name for the object
  can be #auto, see documentation for itcl::class
 
type
  must be a valid event type
  allowed: begin, mid, end, action, guard
 
obj
  an object tag used as a reference
  when type is begin, mid, or end the object tag must be for a rule. For any other type the object tag is another event, which is logically "above" the event being created.
 
y
  y-value for initial placement of Event object
 
?<options>?
  graphical options (see options )
cut
deactivate
delete
  Calls the 'destroy' method. The method is required to provide a standard method for the Menu system to call for any object to be removed. This method is a no-op for Base events (begin/mid/end), since they are not to be deleted directly by the user (it is done implicitly via Rule delete). The gui does not allow you to directly select these events.
deleteSelectBoxes
deploy   y ?<options>?
  A view of the object is placed on the Event's owner Rule at the y-coordinate specified in <y>.
  Graphical options can be passed in, which will be used as default values for all subsequent views of the object which are displayed on any canvas. (Any graphical options not specified will use the class values set up during program start up.)
  The Gui does not directly call this method, as only a Pe is 'deploy'd directly. History is recorded as part of a group history started by Pe.
 
y
  y-value for initial placement of view
 
?<options>?
  graphical options (see options )
destroy
  After checking that architectural conditions are met, a gui::Event_ object is deleted and all views are undisplayed. The command is put onto the Hist/Undo stack.
destructor
  Undisplay all views of the object on any canvas and itcl::delete the object.
display
  Show the graphical items for this object on the current canvas.
dump
fade
findNeighbor   dir ?<options>?
  Look in the direction given by <dir> for a neighboring event. Return the object tag if one is found, otherwise return "".
 
dir
  indicate the direction to look for a neighbor event
  allowed: n, s
 
?<options>?
  other optional arguments
 
-dist <d>
  the distance (in screen units) to look for a neighbor
  if not specified, the default is to look the maximum distance possible, which is the edge of the canvas
getCanvas
getCname
getCommand
  see command explanation here
  see graphical options here
getCoord
getGroupTag
getMsgs
getNext
getOptions
  see command explanation here
  see graphical options here
getPcode
getPrev
getProperties
getPropertyList
highlight
invalidate
isEditable
isOkToDelete
move   mode ?<optional args>?
  Move the y location of an Event up and down on a Rule.
 
mode
  movement control
  An Event object has many restrictions on its movement; it must stay on the rule, it may not change its order with respect to other events, and it may not overlap an event on a neighboring rule. Also, as a base event (begin/mid/end) moves, '$RuleTag adjust' is called to keep the rule shape in sync.
  allowed: start, track, end
 
?<options>?
  arguments used depending on mode
 
-y <f>
  y-coordinate value
 
-align <b>
  control alignment to grid
moveDist
optget
  see command explanation here
  see graphical options here
optmod
  see command explanation here
  see graphical options here
optset
paste
  Paste applicable objects in Istate(selected) to this binder. Valid objects to paste: Event_
raise
  Need to raise the attached message as well.
recall
  Any view of the object on the current canvas is undisplayed. The command is put onto the Hist/Undo stack.
receive
resize
  A select-box has been clicked on and now the user wants to drag it around on the screen. For an event, this does not resize the Event, it actually just moves it around. (And for Begin,Mid,End events it makes it look like the Rule is being resized since an event notifies its rule of a change in position.)
select
  An Event is selected, and we indicate it is selected by drawing a "select box" in the center of the Event
slide
  The event is moved on the Rule body, and other neighbor events on the rule can slide along with it.
  Same modes and usage as rule
unattachMsg
unattachPin
unattachSeg
undisplay
  Remove the graphical items from the canvas which comprise a "view" of the object.
 
view
  View tag which contains the object view to be undisplayed.
  if no View tag is given, try to remove a view of the object on the current canvas.
unfade
unselect
update   ?<options>?
  Bring the view of the Event up-to-date with the Architecture. Architecture changes could have been made in other views that need to be reflected onto this view of the object.
 
?<options>?
  choose pieces to be updated (default is all)
 
-???
  (nothing to do for events yet)

Private Methods
_arch_initopts    
_getHeight    
_getMinSize id args  
_getOrigin dir  
_getWidth    
_initopts    
_setFont font  
_setHeight h args  
_setLinewidth lw  
_setSizeViaItem id args  
_setWidth w args  

State
  Protection Type  
_id private variable  
_lview private variable  
_msgorientation private variable  
_obj private variable  
_opt private variable  
_opt private variable  
_opti private variable  
_propertylist private common  
_sb_placed private variable  
_sbList private variable  
_store private variable  
_store private variable  
_tag private variable  
_tag private variable  
ActionCode public variable  
Description public variable  
GuardExpr public variable  
MsgAttached public variable  
MsgTag public variable  
PinAttached public variable  
PinTag public variable  
RuleTag public variable  
SegAttached public variable  
SegTag public variable  
Subtype public variable  
Type public variable