Foxit PDF SDK

Instance Methods | List of all members
FSStructTreeEntity Class Reference
Inheritance diagram for FSStructTreeEntity:

## Instance Methods
(FSPDFPage *) | - getPage
| Get the related PDF page. More...
(FSStructTreeEntityStructTreeEntityType) | - getType
| Get structure tree entity type. More...
(id) | - init
| Constructor.
(id) | - initWithOther:
| Constructor, with another structure element entity object. More...
(BOOL) | - isEmpty
| Check whether current object is empty or not. More...

## Detailed Description

This class represents structure tree entity.

## Method Documentation

## ◆ getPage()

- (FSPDFPage *) getPage |  |  |

Get the related PDF page.

Returns
  A PDF page object which is the related PDF page.

## ◆ getType()

- (FSStructTreeEntityStructTreeEntityType) getType |  |  |

Get structure tree entity type.

Returns
  Structure tree entity type. Please refer to values starting from FSStructTreeEntityStructTreeEntityTypeElement and this would be one of these values.

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSStructTreeEntity*) | other |

Constructor, with another structure element entity object.

Parameters

  [in] | other | Another structure element entity object.

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
  YES means current object is empty, while NO means not.