TolliumOverlaysComponentBase (open)

Constructor

• MACRO NEW() (inherited from TolliumComponentBase)

Variables

• STRING componenttype (inherited from TolliumComponentBase)
• STRING ARRAY delay_events (inherited from TolliumComponentBase)
  

  Events we don't wish to be immediately informed about

• STRING formfieldtype (inherited from TolliumComponentBase)
• FUNCTION PTR onselect
• BOOLEAN pvt_havepreshown (inherited from TolliumComponentBase)
• OBJECT pvt_parent (inherited from TolliumComponentBase)
• RECORD ARRAY pvt_subcomponents (inherited from TolliumComponentBase)
• RECORD ARRAY yamleventhandlers (inherited from TolliumComponentBase)
• OBJECT yamlscope (inherited from TolliumComponentBase)

Properties

• PROPERTY blockelement (inherited from TolliumComponentBase)
  

  Is this a blockelement?

• PROPERTY contexts (inherited from TolliumComponentBase)
  

  Contexts

• PROPERTY defaultbutton (inherited from TolliumComponentBase)
  

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

• PROPERTY elementtype (inherited from TolliumComponentBase)
  

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

• PROPERTY enabled (inherited from TolliumComponentBase)
  

  Whether this component is enabled

• PROPERTY enabled_on_condition (inherited from TolliumComponentBase)
• PROPERTY errorlabel (inherited from TolliumComponentBase)
  

  Name to show for this component in errors

• PROPERTY flags
• PROPERTY height (inherited from TolliumComponentBase)
  

  Preferred height of the component

• PROPERTY hint (inherited from TolliumComponentBase)
  

  Hint for the component

• PROPERTY invisibletitle (inherited from TolliumComponentBase)
  

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

• PROPERTY isnowvisible (inherited from TolliumComponentBase)
  

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

• PROPERTY minheight (inherited from TolliumComponentBase)
  

  Absolute minimum height of the component

• PROPERTY minwidth (inherited from TolliumComponentBase)
  

  Absolute minimum width of the component

• PROPERTY name (inherited from TolliumComponentBase)
  

  Name of this component.

• PROPERTY overlays
• PROPERTY owner (inherited from TolliumComponentBase)
  

  Screen that owns this component.

• PROPERTY parent (inherited from TolliumComponentBase)
  

  The parent container of this component.

• PROPERTY parentpanel (inherited from TolliumComponentBase)
  

  The parent panel of this component.

• PROPERTY readonly (inherited from TolliumComponentBase)
  

  Whether this component is readonly

• PROPERTY renderedtitle (inherited from TolliumComponentBase)
  

  Title of the component as rendered

• PROPERTY required (inherited from TolliumComponentBase)
  

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

• PROPERTY selection
• PROPERTY subcomponents (inherited from TolliumComponentBase)
  

  List of components this component controls

• PROPERTY supercomponent (inherited from TolliumComponentBase)
  

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

• PROPERTY title (inherited from TolliumComponentBase)
  

  Title of this component

• PROPERTY titleforsubcomponent (inherited from TolliumComponentBase)
  

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

• PROPERTY toddname (inherited from TolliumComponentBase)
  

  Todd name of this component.

• PROPERTY userattributes (inherited from TolliumComponentBase)
  

  User defined attributes

• PROPERTY visible (inherited from TolliumComponentBase)
  

  Whether this component is visible

• PROPERTY width (inherited from TolliumComponentBase)
  

  Preferred width of the component

Functions

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

  Should this component accept external input?

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

  Delete a component.

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

  This component has been updated

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

  Returns the component that should be checked for enableons

• OBJECT FUNCTION GetFocusComponent() (inherited from TolliumComponentBase)
  

  Returns the component that should be focused

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

  Returns all subcomponents (recursive), subcomponents before their supercomponent

• OBJECT FUNCTION GetTitleForComponent() (inherited from TolliumComponentBase)
  

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

• OBJECT ARRAY FUNCTION GetTopDownAllComponents() (inherited from TolliumComponentBase)
  

  Returns all objects top-down

• OBJECT ARRAY FUNCTION GetTopDownUpdatableComponents() (inherited from TolliumComponentBase)
• VARIANT FUNCTION GetUpdateValue() (inherited from TolliumComponentBase)
  

  Get the update value

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

  Invalidate the content

• BOOLEAN FUNCTION IsCurrentlyEnabled() (inherited from TolliumComponentBase)
  

  Are we currently enabled ? (consider enablecomponents)

• BOOLEAN FUNCTION IsFocused() (inherited from TolliumComponentBase)
• BOOLEAN FUNCTION IsNowDisplayed() (inherited from TolliumComponentBase)
  

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

• BOOLEAN FUNCTION IsPartOf(OBJECT comp) (inherited from TolliumComponentBase)
  

  Is this component a subcomponent of a given component?

• BOOLEAN FUNCTION IsShowingOwnContents() (inherited from TolliumComponentBase)
  

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

• BOOLEAN FUNCTION IsUpdateable() (inherited from TolliumComponentBase)
• BOOLEAN FUNCTION IsUpdateValue() (inherited from TolliumComponentBase)
  

  Should we use the value of this component in updates?

• BOOLEAN FUNCTION IsValidValue(VARIANT value) (inherited from TolliumComponentBase)
  

  Validate a value for the component

• BOOLEAN FUNCTION IsVisible() (inherited from TolliumComponentBase)
  

  Is the component currently visible?

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

  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) (inherited from TolliumComponentBase)
• MACRO RecursiveUpdateIsNowVisible() (inherited from TolliumComponentBase)
  

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

• MACRO RemoveFromParent() (inherited from TolliumComponentBase)
  

  Remove a component from its parent

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

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

• MACRO SetYamlProps(RECORD props) (inherited from TolliumComponentBase)
• MACRO StaticInit(RECORD def)
• MACRO ToddUpdate(RECORD updinfo) (inherited from TolliumComponentBase)
• MACRO TolliumDispatchEvent(STRING type, RECORD data) (inherited from TolliumComponentBase)
• MACRO TolliumWebReadOnly(STRING value, BOOLEAN wordwrap) (inherited from TolliumComponentBase)
• MACRO TolliumWebRender()
• MACRO TolliumWeb_ParseEvent(STRING action, STRING param) (inherited from TolliumComponentBase)
• MACRO TolliumWeb_ParseToddEvent(STRING eventtype, RECORD data) (inherited from TolliumComponentBase)
• MACRO UnmarkAsSubcomponent(OBJECT component) (inherited from TolliumComponentBase)
• MACRO UpdatedDependentField(STRING fieldname) (inherited from TolliumComponentBase)
  

  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) (inherited from TolliumComponentBase)
  

  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) (inherited from TolliumComponentBase)
• RECORD FUNCTION Web_PrintAcceptDrops(RECORD acceptdrops) (inherited from TolliumComponentBase)