PTGroup

@interface PTGroup : NSObject

The OCG::Group object represents an optional-content group. This corresponds to a PDF OCG dictionary representing a collection of graphic objects that can be made visible or invisible (Section 4.10.1 ‘Optional Content Groups’ in PDF Reference). Any graphic content of the PDF can be made optional, including page contents, XObjects, and annotations. The specific content objects in the group have an OC entry in the PDF as part of the surrounding marked content or in the XObject dictionary. The group itself is a named object that can be typically manipulated through a Layers panel in a PDF viewer.

In the simplest case, the group’s ON-OFF state makes the associated content visible or hidden. The ON-OFF state of a group can be toggled for a particular context (OCG::Context), and a set of states is kept in a configuration (OCG::Config). The visibility can depend on more than one group in an optional-content membership dictionary (OCG::OCMD), and can also be affected by the context’s draw mode (OCGContext::OCDrawMode).

A group has an Intent entry, broadly describing the intended use. A group’s content is considered to be optional (that is, the group’s state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.

A Usage dictionary entry provides more specific intended usage information than an intent entry. Possible key values are: CreatorInfo, Language, Export, Zoom, Print, View, User, PageElement. The usage value can act as a kind of metadata, describing the sort of things that belong to the group, such as text in French, fine detail on a map, or a watermark. The usage values can also be used by the AutoState mechanism to make decisions about what groups should be on and what groups should be off. The AutoState mechanism considers the usage information in the OCGs, the AS array of the configuration, and external factors; for example, the language the application is running in, the current zoom level on the page, or whether the page is being printed.

  • Creates a new optional-content group (OCG) object in the document.

    Declaration

    Objective-C

    + (PTGroup *)Create:(PTPDFDoc *)doc name:(NSString *)name;

    Swift

    class func create(_ doc: PTPDFDoc!, name: String!) -> PTGroup!

    Parameters

    doc

    The document in which the new OCG will be created.
    name

    The name of the optional-content group.

    Return Value

    The newly created OCG::Group object.

  • Creates a new optional-content group (OCG) object from an existing SDF/Cos object.

    Declaration

    Objective-C

    - (instancetype)initWithOcg:(PTObj *)ocg;

    Swift

    init!(ocg: PTObj!)

  • Declaration

    Objective-C

    - (BOOL)IsValid;

    Swift

    func isValid() -> Bool

    Return Value

    True if this is a valid (non-null) OCG, false otherwise.

  • Declaration

    Objective-C

    - (NSString *)GetName;

    Swift

    func getName() -> String!

    Return Value

    the name of this optional-content group (OCG).

  • Sets the name of this optional-content group (OCG).

    Declaration

    Objective-C

    - (void)SetName:(NSString *)name;

    Swift

    func setName(_ name: String!)

    Parameters

    name

    The new name.

  • Declaration

    Objective-C

    - (BOOL)GetCurrentState:(PTContext *)context;

    Swift

    func getCurrentState(_ context: PTContext!) -> Bool

    Parameters

    context

    The context for which to get the group’s state.

    Return Value

    true if this OCG object is in the ON state in a given context, false otherwise.

  • Sets the current ON-OFF state of the optional-content group (OCG) object in a given context.

    Declaration

    Objective-C

    - (void)SetCurrentState:(PTContext *)context state:(BOOL)state;

    Swift

    func setCurrentState(_ context: PTContext!, state: Bool)

    Parameters

    context

    The context for which to set the group’s state.
    state

    The new state.

  • Note

    If the configuration has a BaseState of Unchanged, and the OCG is not listed explicitly in its ON list or OFF list, then the initial state is taken from the OCG’s current state in the document’s default context.

    Declaration

    Objective-C

    - (BOOL)GetInitialState:(PTConfig *)config;

    Swift

    func getInitialState(_ config: PTConfig!) -> Bool

    Parameters

    config

    The configuration for which to get the group’s initial state.

    Return Value

    The initial state (ON or OFF) of the optional-content group (OCG) object in a given configuration.

  • Sets the initial state (ON or OFF) of the optional-content group (OCG) object in a given configuration.

    Declaration

    Objective-C

    - (void)SetInitialState:(PTConfig *)config state:(BOOL)state;

    Swift

    func setInitialState(_ config: PTConfig!, state: Bool)

    Parameters

    config

    The configuration for which to set the group’s initial state.
    state

    The new initial state, true if the state is ON, false if it is OFF.

  • Declaration

    Objective-C

    - (PTObj *)GetIntent;

    Swift

    func getIntent() -> PTObj!

    Return Value

    OCG intent. An intent is a name object (or an array of name objects) broadly describing the intended use, which can be either “View” or “Design”. A group’s content is considered to be optional (that is, the group’s state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.

  • Sets the Intent entry in an optional-content group’s SDF/Cos dictionary. For more information, see GetIntent().

    Declaration

    Objective-C

    - (void)SetIntent:(PTObj *)intent;

    Swift

    func setIntent(_ intent: PTObj!)

    Parameters

    intent

    The new Intent entry value (a name object or an array of name objects).

  • Declaration

    Objective-C

    - (BOOL)IsLocked:(PTConfig *)config;

    Swift

    func isLocked(_ config: PTConfig!) -> Bool

    Parameters

    config

    The OC configuration.

    Return Value

    true if this OCG is locked in a given configuration, false otherwise. The on/off state of a locked OCG cannot be toggled by the user through the user interface.

  • Sets the locked state of an OCG in a given configuration. The on/off state of a locked OCG cannot be toggled by the user through the user interface.

    Declaration

    Objective-C

    - (void)SetLocked:(PTConfig *)config locked:(BOOL)locked;

    Swift

    func setLocked(_ config: PTConfig!, locked: Bool)

    Parameters

    config

    IN/OUT The optional-content configuration.
    locked

    true if the OCG should be locked, false otherwise.

  • Declaration

    Objective-C

    - (BOOL)HasUsage;

    Swift

    func hasUsage() -> Bool

    Return Value

    true if this group is associated with a Usage dictionary, false otherwise.

  • Declaration

    Objective-C

    - (PTObj *)GetUsage:(NSString *)key;

    Swift

    func getUsage(_ key: String!) -> PTObj!

    Parameters

    key

    The usage key in the usage dictionary entry. The possible key values are: CreatorInfo, Language, Export, Zoom, Print, View, User, PageElement.

    Return Value

    The usage information associated with the given key in the Usage dictionary for the group, or a NULL if the entry is not present. A Usage dictionary entry provides more specific intended usage information than an intent entry.

  • Declaration

    Objective-C

    - (PTObj *)GetSDFObj;

    Swift

    func getSDFObj() -> PTObj!

    Return Value

    Pointer to the underlying SDF/Cos object.