Interface FilterBooleanInterface

The FilterBooleanInterface interface is a FilterItemInterface to elect part instances that have a boolean attribute metadata with the given value (true, false).

This FilterItemInterface selects part instances based on the value of a boolean attribute in their own attributes or their parent attributes (as defined in Documents). Each part instance is considered to have the union between their own attributes and the attributes of its genealogy (parent, grand-parent, etc ...) : the joined attribute set.

The list of attributes and their types is available through the getDictionary function.

The FilterBooleanInterface defines the value of the attribute to check (true/false, setBooleanValue).

The FilterBooleanInterface interface is created through the createBooleanFilter.

The FilterBooleanInterface has the type FT_BOOLEAN (getFilterType).

The FilterBooleanInterface has a depth contribution of 1.

/** 
 * Sample to illustrate how to use a FilterBooleanInterface.
 */
import {
    ConfContextInterface, VisibilityContextInterface, FilterSolverInterface, DataSessionInterface,
    FilterBooleanInterface,
} from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// the attribute name to check against the boolean value true
let lAttributeName : string;

// create the resolution chain : 
// create a filtering context "unconfigured"
// first create ConfContextInterface "unconfigured"
const lConfCtx : ConfContextInterface = lDataSession.createConfContext();
// and create the filtering context and bind it to the unconfigured ConfContextInterface
const lConfVisibilityCtx: VisibilityContextInterface = lDataSession.createVisibilityContext();
lConfVisibilityCtx.setConfContext(lConfCtx);

// create a Filter Solver
const lFilterSolver : FilterSolverInterface = lDataSession.createFilterSolver();

// create a `has attribute` filter
const lBooleanFilter : FilterBooleanInterface = lDataSession.createBooleanFilter();
// useless, FilterOperator.FO_UNION is the default operator when creating a new filter
// lBooleanFilter.setFilterOperator(FilterOperator.FO_UNION);
// set the attribute name that we want to use,
lBooleanFilter.setAttributeName(lAttributeName);
// set the boolean value to check with
lBooleanFilter.setBooleanValue(true);

// and add the filters
// push back (-1) the `has attribute` filter
lFilterSolver.insertFilter(-1, lBooleanFilter);

// set the conf context to use => unconfigured for this example
lFilterSolver.setVisibilityContext(lConfVisibilityCtx);

// and tell the DataSessionInterface to update the modified ConfContextInterface, VisibilityContextInterface and FilterSolverInterfaces
lDataSession.update();

Please refer to Available Filters for a list of other [FilterItemInterfaces](FilterItemInterface.html).
Metadata/Filters

See

Hierarchy

Methods

addEventListener dispose getAttributeName getBooleanValue getDepthContribution getFilterData getFilterId getFilterOperator getFilterType getInfiniteObjectType getParentFilterId hasEventListener isDisposed isEnabled isInverted removeAllEventListeners removeEventListener removeEventListenerById setAttributeName setBooleanValue setEnabled setFilterData setFilterId setFilterOperator setInverted

Methods

addEventListener

  • Adds a listener to an event type.

    When an event of the type pType fires, the callback pListener will be called. This function returns a unique string id that may be used in removeEventListenerById to allow simple listener removal. It is possible to add an object that will be included in the callback to avoid creating too many closures.

    Returns

    The id of the inserted callback (actually an UUID).

    Parameters

    • pType: string
      in
      The type of the event pListener will be called upon.
    • pListener: tListenerCallback
      in
      The listener function that fires when the given event type occurs.
    • pObject: undefined | Object
      in
      The optional object the callback will be called with when the given event fires.

    Returns string

  • Adds a listener to an event type.

    When an event of the type pType fires, the callback pListener will be called. This function returns a unique string id that may be used in removeEventListenerById to allow simple listener removal.

    Returns

    The id of the inserted callback (actually an UUID).

    Parameters

    • pType: string
      in
      The type of the event pListener will be called upon.
    • pListener: tListenerCallback
      in
      The listener function that fires when the given event type occurs.

    Returns string

dispose

getAttributeName

  • Gets the name of the attribute to filter with.

    Returns

    The name of the attribute to use.

    Returns string

getBooleanValue

  • Gets the boolean value of the FilterBooleanInterface.

    A FilterBooleanInterface has the boolean value false by default.

    Returns

    The boolean value of the FilterBooleanInterface.

    Returns boolean

getDepthContribution

  • Gets the depth contribution of the FilterItemInterface.

    This value is usually one.

    Returns

    The depth contribution of the FilterItemInterface.

    Returns number

getFilterData

  • Gets a deep copy of the internal data of the FilterItemInterface.

    Returns

    The internal FilterItemInterface data.

    Returns any

getFilterId

  • Gets the identifier of the FilterItemInterface.

    Returns

    The identifier of the FilterItemInterface.

    Returns string

getFilterOperator

getFilterType

getInfiniteObjectType

getParentFilterId

hasEventListener

  • Tells if the EventDispatcher has such a callback registered for the given event type.

    Returns

    true if such a listener is installed for the given type of event.

    Parameters

    • pType: string
      in
      The type of the event to test.
    • pListener: tListenerCallback
      in
      The listener function that gets tested.

    Returns boolean

isDisposed

  • Tells if this object has been gotten rid off.

    Returns

    true if dispose has been called on this object.

    Returns boolean

isEnabled

  • Tells if the FilterItemInterface is enabled.

    If disabled, this FilterItemInterface is completely ignored during all the computations (the behavior is the same as if it had not been created).

    A FilterItemInterface is enabled by default.

    Returns

    true if the FilterItemInterface is enabled.

    Returns boolean

isInverted

  • Tells if the FilterItemInterface is "inverted".

    When "inverted", a FilterItemInterface elects all the part instances that were not selected if it was not inverted.

    A FilterItemInterface is not "inverted" by default.

    Returns

    true if such a FilterItemInterface is "inverted".

    Returns boolean

removeAllEventListeners

removeEventListener

  • Removes a listener from an event type.

    If no such listener is found, then the function returns false and does nothing. You must use the exact parameters that were used in addEventListener to actually remove the listener.

    Returns

    true if the callback was removed else false.

    Parameters

    • pType: string
      in
      The type of the listener that gets removed.
    • pListener: tListenerCallback

      The listener function that gets removed.

    • pObject: undefined | Object

      The listener object that was used when addEventListener was called.

    Returns boolean

  • Removes a listener from an event type.

    If no such listener is found, then the function returns false and does nothing. You must use the exact parameters that were used in addEventListener to actually remove the listener.

    Returns

    true if the callback was removed else false.

    Parameters

    • pType: string
      in
      The type of the listener that gets removed.
    • pListener: tListenerCallback

      The listener function that gets removed.

    Returns boolean

removeEventListenerById

  • Removes a listener by its id.

    If no such listener is found, then the function returns false and does nothing. You must use the return value of addEventListener to actually remove the listener.

    Returns

    true if the callback was removed else false.

    Parameters

    • pId: string
      in
      The id returned by the call to [addEventListener](FilterBooleanInterface.html#addEventListener) that you want to remove.

    Returns boolean

setAttributeName

  • Sets the name of the attribute to filter with.

    Calling this function with the same attribute name that was set previously does nothing and returns true. If the attribute name is changed and valid, this function will reset getBooleanValue to false.
    Calling this function with an unknown attribute, or an attribute that does not have a boolean value is illegal. In that case, the FilterBooleanInterface is left unchanged and false is returned. Please refer to the getDictionary to get the list of available attributes and their types.

    Use addEventListener on the event FilterDataChanged to know when the FilterBooleanInterface data changed.

    A FilterBooleanInterface has the value false by default (getBooleanValue).

    Returns

    true if the new attribute name was set and legal.

    Parameters

    • pAttributeName: string
      in
      The new name of the attribute to use.

    Returns boolean

setBooleanValue

  • Sets the boolean value of the FilterBooleanInterface.

    If the boolean value if the same as before, nothing is done and true is returned.
    Use addEventListener on the event FilterDataChanged to know when the FilterBooleanInterface data changed.
    A FilterBooleanInterface has the boolean value false by default.

    Returns

    true if pBooleanValue is valid.

    Parameters

    • pBooleanValue: boolean
      in
      The boolean value to set.

    Returns boolean

setEnabled

  • Sets the FilterItemInterface enabled/disabled status.

    If disabled, this FilterItemInterface is completely ignored during all the computations (the behavior is the same as if it had not been created). Use addEventListener on the event FilterEnabledChanged to know when the FilterItemInterface has changed its enabled status.

    A FilterItemInterface is enabled by default.

    Parameters

    • pEnabled: boolean
      in
      If true, the given FilterItemInterface is enabled.

    Returns void

setFilterData

  • Sets the content of the FilterItemInterface from a former call to getFilterData.

    Use addEventListener on the event FilterDataChanged to know when the FilterItemInterface internal data changed.

    Returns

    true if the data is set.

    Parameters

    • pFilterData: any
      in
      Internal FilterItemInterface data to set.

    Returns boolean

setFilterId

  • Sets the identifier of the FilterItemInterface. Make sure the id is unique. A unique FilterItemInterface identifier is created if the identifier is not overridden.

    Parameters

    • pFilterId: string
      in
      The new identifier of the FilterItemInterface.

    Returns void

setFilterOperator

setInverted

  • Sets the "inverted" status of the FilterItemInterface.

    When "inverted", a FilterItemInterface elects all the part instances that were not selected if it was not inverted. Use addEventListener on the event FilterInvertedChanged to know when the FilterItemInterface has changed its "inverted" status.

    A FilterItemInterface is not "inverted" by default.

    Parameters

    • pInverted: boolean
      in
      If true, such a FilterItemInterface will be "inverted".

    Returns void

Settings

Member Visibility

Theme