Class FlexListItemFlavorElement
public class FlexListItemFlavorElement : FlexFlavorElement
- Inheritance
-
FlexListItemFlavorElement
- Derived
- Inherited Members
Properties
ElementRectangle
The client or screen rectangle of the flavor element depending on the value returned by IsClientRectangle.
public override Rectangle ElementRectangle { get; }
Property Value
Remarks
To be implemented by the deriving class.
Enabled
True if the element is enabled. If the element cannot be enabled or disabled, return true.
public override bool Enabled { get; }
Property Value
Remarks
To be implemented by the deriving class.
IsClientRectangle
Determines if the ElementRectangle property returns client or screen coordinates.
public override bool IsClientRectangle { get; }
Property Value
Remarks
To be implemented by the deriving class.
Visible
True if the element is visible.
public override bool Visible { get; }
Property Value
Remarks
To be implemented by the deriving class.
Methods
EnsureVisible()
Ensures that the flavor element is visible.
public override bool EnsureVisible()
Returns
- bool
True if the operation was successful.
GetAttributeValue(Element, string)
Needs to be implemented for attribute value read access.
public override object GetAttributeValue(Element element, string name)
Parameters
Returns
- object
The attribute value.
GetDynamicDescriptors(out IList<AttributeDescriptor>, out IList<ActionDescriptor>)
Gets the descriptors for the dynamic attributes and actions that the element supports.
public override void GetDynamicDescriptors(out IList<AttributeDescriptor> attributes, out IList<ActionDescriptor> actions)
Parameters
attributesIList<AttributeDescriptor>The dynamic attributes that the element supports.
actionsIList<ActionDescriptor>The dynamic actions that the element supports.
Remarks
The default implementation returns empty lists for attributes and
actions. Any overriding method should fill the returned lists.
GetElementCapabilities(Element, out Role, out string[], out string)
Supplies the role, a list of capabilities and a preferred capability names to the caller. This method called when building a new element from the flavor element.
public override void GetElementCapabilities(Element parent, out Role role, out string[] capabilities, out string preferredCap)
Parameters
parentElementThe parent element of the element to be constructed. (for reference only)
roleRoleThe role the element should have.
capabilitiesstring[]The list of capabilities the element should have.
preferredCapstringThe preferred capability the element should have.
GetRuntimeTokenValues()
Gets the runtime token values. This must be implemented by the flavors.
protected override object[] GetRuntimeTokenValues()
Returns
- object[]
A collection of objects representing a runtime token.
HitTest(Point)
Performs an optional hit test on a point within the element's rectangle. The default implementation returns 'true'.
protected override bool HitTest(Point localPoint)
Parameters
localPointPointThe point in local coordinates.
Returns
- bool
Returns true if the point is within the element, otherwise false.
Remarks
This should return 'false' if the point is transparent regarding to mouse clicks.
InvokeAction(Element, string, object[])
Needs to be implemented for element action invocation.
public override object InvokeAction(Element element, string name, object[] args)
Parameters
elementElementThe element instance used.
namestringThe name of the action (lowercased).
argsobject[]A list of invocation parameters.
Returns
SetAttributeValue(Element, string, object)
Needs to be implemented for attribute value write access.
public override void SetAttributeValue(Element element, string name, object value)