Class ResetFormAction

PDF action to reset form fields in the current document.

It is an Immutable.Record and thus can be updated using set(key, value), for example: action.set("includeExclude", false);.

A ResetFormAction defines which form fields should be reset, when clicked on it. By default all form fields will be reset to their default value. The includeExclude field defines if the fields specified by fields, which are a NutrientViewer.Immutable.List of form field names, should reset all form fields excluding the defined fields or just the defined fields. When includeExclude is set to true, all form fields except the fields defined in fields will be reset. If includeExclude is set to false, which is the default value for this field, only the form fields defined in fields will be reset.

Example

Create a new ResetFormAction

const action = new NutrientViewer.Actions.ResetFormAction({
  fields: List(["exampleField"])
});

Hierarchy

ResetFormActionData
NutrientViewer.Actions.Action
- ResetFormAction

Index

Constructors

constructor

new ResetFormAction(
    args?: { includeExclude?: boolean } & {
        fields?: NutrientViewer.Immutable.List<string> | null;
    } & {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    },
): NutrientViewer.Actions.ResetFormAction
Parameters
- Optionalargs: { includeExclude?: boolean } & {
      fields?: NutrientViewer.Immutable.List<string> | null;
  } & {
      subActions?: | NutrientViewer.Immutable.List<
          NutrientViewer.Actions.Action,
      >
      | null;
  }
  - OptionalincludeExclude?: boolean
    If false, the fields list specifies which fields to reset. If true, the fields list indicates which fields to exclude from resetting. That is, all fields in the document’s interactive form shall be reset except those listed in the fields list.
    
    Default
    false
  - Optionalfields?: NutrientViewer.Immutable.List<string> | null
  - OptionalsubActions?: NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null
Returns NutrientViewer.Actions.ResetFormAction
Inherited from ResetFormActionData.constructor

Properties

fields

fields: NutrientViewer.Immutable.List<string> | null | undefined

A List identifying which fields to reset or which to exclude from resetting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are reset.

Default

null

includeExclude

includeExclude: boolean = ...

If false, the fields list specifies which fields to reset. If true, the fields list indicates which fields to exclude from resetting. That is, all fields in the document’s interactive form shall be reset except those listed in the fields list.

Default

false

`Optional`subActions

subActions?: NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

Actions can be chained by adding them to this immutable List.

Methods

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from Action.asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from Action.asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns this
Inherited from Action.clear

delete

delete<K extends "subActions">(key: K): this
Returns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns this
Alias
remove

Inherited from Action.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Alias
removeIn

Inherited from Action.deleteIn

equals

equals(other: unknown): boolean
Parameters
- other: unknown
Returns boolean
Inherited from Action.equals

get

get<K extends "subActions">(
    key: K,
): {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
- keyPath: Iterable<unknown>
- OptionalnotSetValue: unknown
Returns unknown
Inherited from Action.getIn

has

has(key: unknown): boolean
Parameters
- key: unknown
Returns boolean
Inherited from Action.has

merge

merge(
    ...collections: Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >[],
): this
Parameters
- ...collections: Partial<
      {
          subActions?: | NutrientViewer.Immutable.List<
              NutrientViewer.Actions.Action,
          >
          | null;
      },
  >[]
Returns this
Inherited from Action.merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >
  )[]
Returns this
Inherited from Action.mergeDeep

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >
  )[]
Returns this
Inherited from Action.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
- merger: (previous?: unknown, next?: unknown, key?: string) => unknown
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >
  )[]
Returns this
Inherited from Action.mergeDeepWith

mergeIn

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >
  )[]
Returns this
Inherited from Action.mergeIn

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
- merger: (previous?: unknown, next?: unknown, key?: string) => unknown
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >
  )[]
Returns this
Inherited from Action.mergeWith

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Action.removeIn

set

set<K extends "subActions">(
    key: K,
    value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K],
): this
Type Parameters
- K extends "subActions"
Parameters
- key: K
- value: {
      subActions?:
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
          | null;
  }[K]
Returns this
Inherited from Action.set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
- keyPath: Iterable<unknown>
- value: unknown
Returns this
Inherited from Action.setIn

toJS

toJS(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJS

toJSON

toJSON(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJSON

toSeq

toSeq(): Keyed<string, unknown>
Returns Keyed<string, unknown>
Inherited from Action.toSeq

update

update<K extends "subActions">(
    key: K,
    updater: (
        value: {
            subActions?:
                | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
                | null;
        }[K],
    ) => {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    }[K],
): this
Type Parameters
- K extends "subActions"
Parameters
- key: K
- updater: (
      value: {
          subActions?:
              | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
              | null;
      }[K],
  ) => {
      subActions?: | NutrientViewer.Immutable.List<
          NutrientViewer.Actions.Action,
      >
      | null;
  }[K]
Returns this
Inherited from Action.update

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
- keyPath: Iterable<unknown>
- notSetValue: unknown
- updater: (value: unknown) => unknown
Returns this
Inherited from Action.updateIn
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
- keyPath: Iterable<unknown>
- updater: (value: unknown) => unknown
Returns this
Inherited from Action.updateIn

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => unknown
Returns this
See
Map#withMutations

Inherited from Action.withMutations

Class ResetFormAction

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalincludeExclude?: boolean

Default

Optionalfields?: NutrientViewer.Immutable.List<string> | null

OptionalsubActions?: NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

Returns NutrientViewer.Actions.ResetFormAction

Properties

fields

Default

includeExclude

Default

OptionalsubActions

Methods

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { subActions?: | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null;}[K]

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

removeIn

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

setIn

Parameters

Returns this

`Optional`includeExclude?: boolean

`Optional`fields?: NutrientViewer.Immutable.List<string> | null

`Optional`subActions?: NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

`Optional`subActions

Returns {
subActions?:
| NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
| null;
}[K]

Returns {
subActions?:
| NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
| null;
}

Returns {
subActions?:
| NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
| null;
}