Public Instance Constructors
SUL Constructor
|
Initializes a new instance of the SUL class. |
Public Instance Properties
 anchor |
This member is not relevant to this class. |
| attached (inherited from XComponent) | Whether the component is attached to the user session. |
| attrValue | |
| bgColor |
This member is not relevant to this class. |
| bgImage |
This member is not relevant to this class. |
| bgImageLayout |
This member is not relevant to this class. |
| bottomMargin |
This member is not relevant to this class. |
| cell |
This member is not relevant to this class. |
| children (inherited from XComponent) | Returns a list children components. |
| columnSpan |
This member is not relevant to this class. |
| container (inherited from SComponent) | Whether the component may have children. |
| content (inherited from SComponent) | |
| contextMenu | Returns the context menu with the given ID. |
| cursor |
This member is not relevant to this class. |
| data (inherited from XComponent) | Application data closely associated with this UI component. This property allows applications to attached application data to this component. |
| defaultFocusIndex | |
| deserializing (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Whether the componenet is being deserialized from XML. |
| dock |
This member is not relevant to this class. |
| element (inherited from XComponent) | The XML element that represents this component. |
| elementName | |
| enabled | See enabled. |
| fgColor |
This member is not relevant to this class. |
| flowBreak |
This member is not relevant to this class. |
| focusIndex |
This member is not relevant to this class. |
| font |
This member is not relevant to this class. |
| height |
This member is not relevant to this class. |
| id (inherited from XComponent) | The unique XML ID of this UI component. |
| immediateShell (inherited from SComponent) | The immediate window or dialog that contains this component. |
| index (inherited from XComponent) | Returns the current component's position under it's parent. |
| leftMargin |
This member is not relevant to this class. |
| menu |
This member is not relevant to this class. |
| namespacePrefix (inherited from SComponent) | |
| namespaceUri (inherited from SComponent) | |
| nextSibling (inherited from XComponent) | Returns the next sibling component under the same parent. |
| parent (inherited from XComponent) | The parent of this UI component. |
| prevSibling (inherited from XComponent) | Returns the previous sibling component under the same parent. |
| rightMargin |
This member is not relevant to this class. |
| root (inherited from XComponent) | The root of the UI tree this component belongs to. |
| rowSpan |
This member is not relevant to this class. |
| selectors (inherited from XComponent) | Given a qualified event type, returns a list of event selectors attached to this component. |
| serializing (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Whether the componenet is being serialized into XML. |
| session (inherited from XComponent) | The user session this UI component is attached to. The UI component must be attached to the user session for it to be rendered by the client. To attach a UI component to the session, you may set the componentRoot property if the session is empty. If there is already a tree of UI components in the session, you may simply add this UI component to the tree using the addChild method. |
| specEnabled (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Whether this component is explicitly specified (e.g. in XML) to be enabled. |
| specVisible (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Whether this component is explicitly specified (e.g. in XML) to be visible. |
| template (inherited from XComponent) | The UI template this component is attached to. If this component is loaded from a UI template, this property identifies the UI template. When the component is attached to the user session, it will be automatically detached from the UI template. |
| tooltip |
This member is not relevant to this class. |
| topLayout (inherited from SComponent) | The top most layout container (e.g. top most shell) that contains this component. |
| topMargin |
This member is not relevant to this class. |
| visible | See visible. |
| width |
This member is not relevant to this class. |
| x |
This member is not relevant to this class. |
| y |
This member is not relevant to this class. |
Public Instance Methods
| activeDialogBranch | Returns the top level dialog which is or contains the global active dialog. |
| addChild (inherited from XComponent) | Overloaded. Add the child c to this component. |
| addChildCore (inherited from SComponent) | Overloaded. |
| addChildren (inherited from XComponent) | Adds an array of children to this component. |
| addEventHandler (inherited from XComponent) | Add an event handler to the component. This is a convenience method. It will automatically created an event selector, add the event handler to the selector via addHandler, and attach the selector to the component via addEventSelector. |
| addEventSelector (inherited from XComponent) | Add an event selector to this component. |
| addKeyCharEventHandler |
This member is not relevant to this class. |
| addKeyDownEventHandler |
This member is not relevant to this class. |
| addKeyUpEventHandler |
This member is not relevant to this class. |
| addMouseClickEventHandler |
This member is not relevant to this class. |
| addMouseDoubleClickEventHandler |
This member is not relevant to this class. |
| addMouseDownEventHandler |
This member is not relevant to this class. |
| addMouseUpEventHandler |
This member is not relevant to this class. |
| ancestorOf (inherited from XComponent) | Returns whether the current component is an ancestor of comp. |
| attrModelIDRef | |
| childDialogs | Returns a list of child dialogs. |
| childWindows | Returns a list of child windows. |
| Clone (inherited from SComponent) | |
| deserialize (inherited from SComponent) | |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| findEventSelector (inherited from XComponent) | Find the first event selector matching the criteria defined by eventType and async. |
| firstVisibleChildWindow | Returns the first visible child window, if exists. |
| focus |
This member is not relevant to this class. |
| getChild (inherited from XComponent) | Find and return the child component with the matching ID. |
| getDescendant (inherited from XComponent) | Find and return the descendant component with the matching ID. |
| getDescendantCount (inherited from XComponent) | Returns the number of descendants of the current component. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| getResources (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. See getResources. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| hasActiveDialog | Whether there is a global active dialog (i.e. an active descendant dialog). |
| moveAfterEventSelector (inherited from XComponent) | Move the selector es after its sibling sibling. |
| moveBeforeEventSelector (inherited from XComponent) | Move the selector es before its sibling sibling. |
| moveChild (inherited from XComponent) | Move the child c to a new position under this component. |
| moveChildCore (inherited from XComponent) |
This member is intended for component developers, and should not be used directly in application code. Move the child c to a new position under this component. |
| processIDRefs (inherited from XComponent) |
This member supports the XUP framework infrastructure, and should not be used directly in application code. For all attributes of this component that point to UI components, turn the IDREF values into concrete UI components. In addition, recurse to all descendants of this component. |
| removeAllChildren (inherited from XComponent) | Removes all children. |
| removeChild (inherited from SComponent) | Overloaded. |
| removeChildCore (inherited from XComponent) | Overloaded.
This member is intended for component developers, and should not be used directly in application code. Remove the child c from this component. |
| removeChildren (inherited from XComponent) | Removes a range of children. |
| removeEventHandler (inherited from XComponent) | Remove the event handler from this component. This method removes the event handler found in the first event selector attached to this component. |
| removeEventSelector (inherited from XComponent) | Remove the event selector from this component. |
| separate (inherited from XComponent) | Remove this component from its from parent. |
| serialize (inherited from SComponent) | |
| setAnchorCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the anchor value of the componennt. |
| setBottomMarginCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the bottom margin of the componennt. |
| setDockCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the dock value of the componennt. |
| setFocusIndexCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the focus index of the componennt. |
| setHeight (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the height of the componennt. |
| setLeftMarginCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the left margin of the componennt. |
| setRightMarginCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the right margin of the componennt. |
| setTopMarginCore (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the top margin of the componennt. |
| setWidth (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the width of the componennt. |
| setX (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the x-coordinate of the componennt. |
| setY (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Sets the y-coordinate of the componennt. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| updateSulAttr (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. This method takes care of SUL namespace when adding UI attributes to XUpdates. |
| visibleChildDialog | Returns the visible child dialog, if exists. |
Public Instance Events
 Separated (inherited from XComponent) |
This member is intended for component developers, and should not be used directly in application code. The component fires this event when it is removed from its parent, regardless whether the component is attached to the user session or not; in this case both sender and orig are set to this component. In addition, the component will also fire this event if one of its ancestors is removed from that ancestor's parent; in this case, sender is set to this component, but |
Protected Instance Fields
 iHeight (inherited from SComponent) | |
| iWidth (inherited from SComponent) | |
| iX (inherited from SComponent) | |
| iY (inherited from SComponent) | |
| mAnchor (inherited from SComponent) | |
| mBgColor (inherited from SComponent) | |
| mBgImageId (inherited from SComponent) | |
| mBgImageLayout (inherited from SComponent) | |
| mBottomMargin (inherited from SComponent) | |
| mCell (inherited from SComponent) | |
| mColumnSpan (inherited from SComponent) | |
| mCursor (inherited from SComponent) | |
| mDeserializing (inherited from SComponent) | |
| mDock (inherited from SComponent) | |
| mEnabled (inherited from SComponent) | |
| mFgColor (inherited from SComponent) | |
| mFlowBreak (inherited from SComponent) | |
| mFocusIndex (inherited from SComponent) | |
| mFont (inherited from SComponent) | |
| mLeftMargin (inherited from SComponent) | |
| mMenuId (inherited from SComponent) | |
| mRightMargin (inherited from SComponent) | |
| mRowSpan (inherited from SComponent) | |
| mSerializing (inherited from SComponent) | |
| mTooltip (inherited from SComponent) | |
| mTopMargin (inherited from SComponent) | |
| mVisible (inherited from SComponent) |
Protected Instance Properties
 mBgImage (inherited from SComponent) | |
| mCtxMenu (inherited from SComponent) | |
| sulAttrValue (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. This property takes care of SUL namespace when calling attrValue. |
Protected Instance Methods
 checkChild | |
| deserializeAttrs | |
| deserializeChildren (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Deserializes children from XML. |
| deserializeContent (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Deserializes content from XML. |
| Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| getSulXmlAttr (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. This function takes care of namespace issues when getting an XML attribute value. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
| serializeAttrs | |
| serializeChildren (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Serializes children into XML. |
| serializeContent (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. Serializes content into XML. |
| setSulXmlAttr (inherited from SComponent) |
This member is intended for component developers, and should not be used directly in application code. This method takes care of namespace issues when setting an XML attribute. |
Protected Internal Instance Fields
 mRequestingFocus (inherited from SComponent) |
See Also
SUL Class | org.openxup.ui.sul Namespace