TolliumComponentBase (open)

Constructor

• MACRO NEW()

Variables

• STRING componenttype
• STRING ARRAY delay_events
  

  Events we don't wish to be immediately informed about

• STRING formfieldtype
• BOOLEAN pvt_havepreshown
• OBJECT pvt_parent
• RECORD ARRAY pvt_subcomponents
• RECORD ARRAY yamleventhandlers
• OBJECT yamlscope

Properties

• PROPERTY blockelement
  

  Is this a blockelement?

• PROPERTY contexts
  

  Contexts

• PROPERTY defaultbutton
  

  Button that must be activated when this component is focused and enter is pushed.

• PROPERTY elementtype
  

  XML Element type, either the localname or namespace#localname if not a tollium screens component

• PROPERTY enabled
  

  Whether this component is enabled

• PROPERTY enabled_on_condition
• PROPERTY errorlabel
  

  Name to show for this component in errors

• PROPERTY height
  

  Preferred height of the component

• PROPERTY hint
  

  Hint for the component

• PROPERTY invisibletitle
  

  Whether this component hides its title. Should only be set in NEW(). May be deprecatd inthe future

• PROPERTY isnowvisible
  

  Whether the component and its (grand*)parents are visible

• PROPERTY minheight
  

  Absolute minimum height of the component

• PROPERTY minwidth
  

  Absolute minimum width of the component

• PROPERTY name
  

  Name of this component.

• PROPERTY owner
  

  Screen that owns this component.

• PROPERTY parent
  

  The parent container of this component.

• PROPERTY parentpanel
  

  The parent panel of this component.

• PROPERTY readonly
  

  Whether this component is readonly

• PROPERTY renderedtitle
  

  Title of the component as rendered

• PROPERTY required
  

  Whether these value is required (the user must enter a non-default value)

• PROPERTY subcomponents
  

  List of components this component controls

• PROPERTY supercomponent
  

  Component that controls this component (may only be set once)

• PROPERTY title
  

  Title of this component

• PROPERTY titleforsubcomponent
  

  Sets the subcomponent that will be activated when the label of this component is clicked on. For internal use only.

• PROPERTY toddname
  

  Todd name of this component.

• PROPERTY userattributes
  

  User defined attributes

• PROPERTY visible
  

  Whether this component is visible

• PROPERTY width
  

  Preferred width of the component

Functions

• INTEGER FUNCTION AddYamlEventHandler(STRING eventtype, VARIANT callback)
• BOOLEAN FUNCTION AllowExternalUpdates()
  

  Should this component accept external input?

• MACRO ChildVisibilityChanged(OBJECT child)
• MACRO CompositionMetadataIsUpdated()
• OBJECT FUNCTION CreateCustomSubComponent(STRING namespace, STRING type, RECORD options)
• OBJECT FUNCTION CreateSubComponent(STRING type, RECORD options)
• MACRO DeleteComponent()
  

  Delete a component.

• MACRO DirtyCleared()
• MACRO DispatchYamlEvents(STRING eventtype)
• BOOLEAN FUNCTION EnabledOn(INTEGER min, INTEGER max, STRING ARRAY flags, STRING selectionmatch)
• MACRO ExecutePathAction(STRING path)
• MACRO ExtUpdatedComponent()
  

  This component has been updated

• MACRO ExtUpdatedComponentList()
• OBJECT ARRAY FUNCTION GetChildComponents()
• STRING FUNCTION GetComponentIdentification()
• RECORD FUNCTION GetComponentOutline(RECORD options)
• STRING FUNCTION GetDefaultHeight()
• STRING FUNCTION GetDefaultMinimumHeight()
• STRING FUNCTION GetDefaultWidth()
• RECORD ARRAY FUNCTION GetDraggedItems(RECORD ARRAY rawitems)
• OBJECT FUNCTION GetEnableOnComponent()
  

  Returns the component that should be checked for enableons

• OBJECT FUNCTION GetFocusComponent()
  

  Returns the component that should be focused

• STRING FUNCTION GetHeight()
• STRING FUNCTION GetMinimumHeight()
• STRING FUNCTION GetMinimumWidth()
• STRING FUNCTION GetSaveStateKey()
• RECORD FUNCTION GetStandardAttributes(STRING type)
• INTEGER FUNCTION GetSubcomponentIndex(OBJECT findcomponent)
• OBJECT ARRAY FUNCTION GetSubcomponentsRecursive()
  

  Returns all subcomponents (recursive), subcomponents before their supercomponent

• OBJECT FUNCTION GetTitleForComponent()
  

  Returns the component for which our title is the label (either the current component or a subcomponent)

• OBJECT ARRAY FUNCTION GetTopDownAllComponents()
  

  Returns all objects top-down

• OBJECT ARRAY FUNCTION GetTopDownUpdatableComponents()
• VARIANT FUNCTION GetUpdateValue()
  

  Get the update value

• VARIANT FUNCTION GetUserAttribute(STRING namespace, STRING attr)
• STRING FUNCTION GetWidth()
• MACRO Invalidate()
  

  Invalidate the content

• BOOLEAN FUNCTION IsCurrentlyEnabled()
  

  Are we currently enabled ? (consider enablecomponents)

• BOOLEAN FUNCTION IsFocused()
• BOOLEAN FUNCTION IsNowDisplayed()
  

  Returns true if the component is currently displayed to the user (ie a client-side 'now visible')

• BOOLEAN FUNCTION IsPartOf(OBJECT comp)
  

  Is this component a subcomponent of a given component?

• BOOLEAN FUNCTION IsShowingOwnContents()
  

  Returns whether this component is showing its own content. If FALSE, isnowvisible is always FALSE

• BOOLEAN FUNCTION IsUpdateable()
• BOOLEAN FUNCTION IsUpdateValue()
  

  Should we use the value of this component in updates?

• BOOLEAN FUNCTION IsValidValue(VARIANT value)
  

  Validate a value for the component

• BOOLEAN FUNCTION IsVisible()
  

  Is the component currently visible?

• RECORD FUNCTION LookupDownload(RECORD data)
• RECORD FUNCTION LookupDragout(RECORD draginfo)
• MACRO MarkAsSubcomponent(OBJECT component)
• MACRO OnUnloadComponent()
• MACRO ProcessInboundMessage(STRING type, RECORD msgdata)
• MACRO QueueInboundMessage(STRING type, RECORD msgdata)
  

  Queue an inbound message. This is called as soon as the message arrives and can be used to preinspect, modify or drop messages. The actual handling of the message should usually be delayed to ProcessInboundMessage, as any waits here will block all event processing, and trying to start a modal dialog will deadlock the message loop

• MACRO QueueOutboundMessage(STRING type, RECORD msgdata)
• MACRO RecursiveUpdateIsNowVisible()
  

  Recursively updates the value of isnowvisible. Call this function when any of the dependencies for that value has changed.

• MACRO RemoveFromParent()
  

  Remove a component from its parent

• MACRO ResetParentRecursive()
• MACRO RestoreComponentState()
• MACRO SaveComponentState()
• MACRO SetSubcomponentPosition(OBJECT component, OBJECT insertpos, BOOLEAN do_after, BOOLEAN break_inbetween)
• MACRO SetUserAttribute(STRING namespace, STRING attr, VARIANT newvalue)
• BOOLEAN FUNCTION SetValueIfValid(VARIANT newvalue)
  

  Set the value for this component, if the value is acceptable

• MACRO SetYamlProps(RECORD props)
• MACRO StaticInit(RECORD def)
  

  Initialize a component with it parsed defintioon from an XML

• MACRO ToddUpdate(RECORD updinfo)
• MACRO TolliumDispatchEvent(STRING type, RECORD data)
• MACRO TolliumWebReadOnly(STRING value, BOOLEAN wordwrap)
• MACRO TolliumWebRender()
• MACRO TolliumWeb_ParseEvent(STRING action, STRING param)
• MACRO TolliumWeb_ParseToddEvent(STRING eventtype, RECORD data)
• MACRO UnmarkAsSubcomponent(OBJECT component)
• MACRO UpdatedDependentField(STRING fieldname)
  

  Called when a field has been registered as dependent on another component's value for that field, and the dependent value has changed.

• MACRO ValidateValue(OBJECT work)
  

  Called by BeginWork, after work has been started, must be used to validate values

• RECORD FUNCTION VerifyDrop(RECORD acceptdrops, RECORD dropdata, RECORD target, STRING ARRAY alltargetflags)
• RECORD FUNCTION Web_PrintAcceptDrops(RECORD acceptdrops)