Package apple.pdfkit

Class PDFOutline

    • Constructor Detail

      • PDFOutline

        protected PDFOutline​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • action

        @Nullable
public @Nullable PDFAction action()
        Action performed when a user clicks on the PDFOutline. Equivalent to calling -[destination] above when the outline has a destination (-[action] will return a PDFActionGoTo object). Some outlines do not have destinations however and you must therefore call this method. The root outline item will never return either an action or a destination. Calling -[setAction] on the root item has no effect. API-Since: 11.0

      • allocWithZone

        public static PDFOutline allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • childAtIndex

        @Nullable
public @Nullable PDFOutline childAtIndex​(long index)
        PDFOutline child at index. Will throw exception if index is out of range.

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • destination

        @Nullable
public @Nullable PDFDestination destination()
        Set: Has no effect on the root PDFOutline item. If the item previously had an action associated with it, the action is released (PDFOutline items cannot have both an action and a destination, they are mutually exclusive). The preferred way though is to call -[setAction] below.

      • document

        @Nullable
public @Nullable PDFDocument document()
        The PDFDocument the outline is associated with.

      • hash_static

        public static long hash_static()

      • index

        public long index()
        Returns the index of the outline item - that is, relative to its siblings (and from the perspective of the parent). The root outline item (or any item with no parent) is always index 0. API-Since: 11.0

      • init

        public PDFOutline init()
        Returns a PDFOutline object. If this object is to be the outline root, you will need to add additional PDFOutline objects to form the outline hierarchy you desire. You will then need to add it to a PDFDocument by passing it to -[PDFDocument setOutlineRoot:]. If this is to be a child (non-root) outline you will need to set a label for it and either a destination or action for it. Also, you will need to add it as a child of another PDFOutline object.
        Overrides:
        init in class NSObject

      • insertChildAtIndex

        public void insertChildAtIndex​(@NotNull
                               @NotNull PDFOutline child,
                               long index)
        To build up a PDFOutline hierarchy, you call this method to add children outline items. For the simplest of outlines you would, at the very least, have to add items to the outline root item. NOTE: Be careful when calling this for a PDFOutline item which already has a parent (for example when moving items around within an outline hierarchy) - you should retain the item and call -[removeFromParent] first. API-Since: 11.0

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isOpen

        public boolean isOpen()
        Indicates whether PDFOutline item is initially disclosed or not. If the outline item has no children, -[isOpen] is always NO and calling -[setIsOpen] has no effect. The root item always returns YES for -[isOpen] and calling -[setIsOpen] also has no effect. API-Since: 11.0

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • label

        @Nullable
public @Nullable java.lang.String label()
        The label for the outline. The root PDFOutline has no label and is only a container for children PDFOutlines.

      • numberOfChildren

        public long numberOfChildren()
        Number of PDFOutline children this PDFOutline has.

      • parent

        @Nullable
public @Nullable PDFOutline parent()
        Returns the parent outline (the root outline will return nil). API-Since: 11.0

      • removeFromParent

        public void removeFromParent()
        Removes self from parent (for root outline, does nothing since the root has no parent). API-Since: 11.0

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setAction

        public void setAction​(@Nullable
                      @Nullable PDFAction value)
        Action performed when a user clicks on the PDFOutline. Equivalent to calling -[destination] above when the outline has a destination (-[action] will return a PDFActionGoTo object). Some outlines do not have destinations however and you must therefore call this method. The root outline item will never return either an action or a destination. Calling -[setAction] on the root item has no effect. API-Since: 11.0

      • setDestination

        public void setDestination​(@Nullable
                           @Nullable PDFDestination value)
        Set: Has no effect on the root PDFOutline item. If the item previously had an action associated with it, the action is released (PDFOutline items cannot have both an action and a destination, they are mutually exclusive). The preferred way though is to call -[setAction] below.

      • setIsOpen

        public void setIsOpen​(boolean value)
        Indicates whether PDFOutline item is initially disclosed or not. If the outline item has no children, -[isOpen] is always NO and calling -[setIsOpen] has no effect. The root item always returns YES for -[isOpen] and calling -[setIsOpen] also has no effect. API-Since: 11.0

      • setLabel

        public void setLabel​(@Nullable
                     @Nullable java.lang.String value)
        The label for the outline. The root PDFOutline has no label and is only a container for children PDFOutlines.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.