Package net.webpdf.wsclient.openapi

Class OperationThreadActionGoToThread

java.lang.Object

net.webpdf.wsclient.openapi.OperationThreadActionGoToThread

public class OperationThreadActionGoToThread
extends Object

When activated, the goToThread action jumps to a specific thread defined in the document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BEAD_INDEX
static String	JSON_PROPERTY_PAGE
static String	JSON_PROPERTY_THREAD_INDEX
static String	JSON_PROPERTY_THREAD_TITLE

Constructor Summary

Constructors

Constructor	Description
OperationThreadActionGoToThread()

Method Summary

Modifier and Type	Method	Description
OperationThreadActionGoToThread	beadIndex(Integer beadIndex)
boolean	equals(Object o)
@Nullable Integer	getBeadIndex()	The index of the thread section to which the jump should be.
@Nullable Integer	getPage()	The page number of the page where the thread is found.
@Nullable Integer	getThreadIndex()	The index of the thread in the document's thread directory to which the jump should be.
@Nullable String	getThreadTitle()	The title of the thread to which the jump should be.
int	hashCode()
OperationThreadActionGoToThread	page(Integer page)
void	setBeadIndex(Integer beadIndex)
void	setPage(Integer page)
void	setThreadIndex(Integer threadIndex)
void	setThreadTitle(String threadTitle)
OperationThreadActionGoToThread	threadIndex(Integer threadIndex)
OperationThreadActionGoToThread	threadTitle(String threadTitle)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_BEAD_INDEX

public static final String JSON_PROPERTY_BEAD_INDEX

See Also:

Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_THREAD_INDEX

public static final String JSON_PROPERTY_THREAD_INDEX

See Also:

Constant Field Values

JSON_PROPERTY_THREAD_TITLE

public static final String JSON_PROPERTY_THREAD_TITLE

See Also:

Constant Field Values

Constructor Detail

OperationThreadActionGoToThread

public OperationThreadActionGoToThread()

Method Detail

beadIndex

public OperationThreadActionGoToThread beadIndex(Integer beadIndex)

getBeadIndex

@Nullable
public @Nullable Integer getBeadIndex()

The index of the thread section to which the jump should be. This value is optional and does not need to be specified. minimum: 0

Returns:

beadIndex

setBeadIndex

public void setBeadIndex(Integer beadIndex)

page

public OperationThreadActionGoToThread page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

The page number of the page where the thread is found. minimum: 1

Returns:

page

setPage

public void setPage(Integer page)

threadIndex

public OperationThreadActionGoToThread threadIndex(Integer threadIndex)

getThreadIndex

@Nullable
public @Nullable Integer getThreadIndex()

The index of the thread in the document's thread directory to which the jump should be. This value is an alternative to \"threadTitle\" and does not have to be set if the latter has been specified. minimum: 0

Returns:

threadIndex

setThreadIndex

public void setThreadIndex(Integer threadIndex)

threadTitle

public OperationThreadActionGoToThread threadTitle(String threadTitle)

getThreadTitle

@Nullable
public @Nullable String getThreadTitle()

The title of the thread to which the jump should be. This value is an alternative to \"threadIndex\" and does not have to be set if the latter has been specified.

Returns:

threadTitle

setThreadTitle

public void setThreadTitle(String threadTitle)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object