Package com.j3d.gen.docs.api

Class HeaderIdentifier

java.lang.Object

com.j3d.gen.docs.api.HeaderIdentifier

public class HeaderIdentifier
extends Object

Represents a TWHeader within a DocsFrame's JTree. *

This class is used to identify a header within the help documentation, allowing for navigation and hierarchical representation in a JTree.

Author:

Lehlogonolo Poole

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	fileHead	A boolean indicating if this identifier represents the head of a file (i.e., the document's main title).
private DefaultMutableTreeNode	node	The DefaultMutableTreeNode in the JTree that corresponds to this header.
private TextPanel	panel	The TextPanel where this header's content is displayed.
private String	parsedId	The parsed, unique ID for this header, used for navigation and linking.
private BiConsumer<JPanel,JScrollPane>	scrollTo	A BiConsumer that defines how to scroll to this header's content within a JScrollPane.
private final String	title	The title of the header.
private TWHeader	token	The TWHeader token associated with this identifier, if it represents a specific header.

Constructor Summary

Constructors

Constructor	Description
HeaderIdentifier(TWHeader token, TextPanel panel)	Constructs a new HeaderIdentifier for a specific header token.
HeaderIdentifier(String title)	Constructs a new HeaderIdentifier representing the head of a file (document's main title).

Method Summary

Modifier and Type	Method	Description
DefaultMutableTreeNode	getNode()
TextPanel	getPanel()
String	getParsedId()
BiConsumer<JPanel,JScrollPane>	getScrollTo()
TWHeader	getToken()
boolean	isFileHead()
void	parseId(LinkedHashMap<String,HeaderIdentifier> other)
void	setNode(DefaultMutableTreeNode node)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

token

private TWHeader token

The TWHeader token associated with this identifier, if it represents a specific header.

panel

private TextPanel panel

The TextPanel where this header's content is displayed.

scrollTo

private BiConsumer<JPanel,JScrollPane> scrollTo

A BiConsumer that defines how to scroll to this header's content within a JScrollPane.

fileHead

private boolean fileHead

A boolean indicating if this identifier represents the head of a file (i.e., the document's main title).

title

private final String title

The title of the header.

node

private DefaultMutableTreeNode node

The DefaultMutableTreeNode in the JTree that corresponds to this header.

parsedId

private String parsedId

The parsed, unique ID for this header, used for navigation and linking.

Constructor Details

HeaderIdentifier

public HeaderIdentifier(TWHeader token,
 TextPanel panel)

Constructs a new HeaderIdentifier for a specific header token.

Parameters:

token - The TWHeader token representing the header.

panel - The TextPanel where the header's content is displayed.

HeaderIdentifier

public HeaderIdentifier(String title)

Constructs a new HeaderIdentifier representing the head of a file (document's main title).

Parameters:

title - The title of the file head.

Method Details

parseId

public void parseId(LinkedHashMap<String,HeaderIdentifier> other)

isFileHead

public boolean isFileHead()

getToken

public TWHeader getToken()

getPanel

public TextPanel getPanel()

getScrollTo

public BiConsumer<JPanel,JScrollPane> getScrollTo()

toString

public String toString()

Overrides:

toString in class Object

setNode

public void setNode(DefaultMutableTreeNode node)

getNode

public DefaultMutableTreeNode getNode()

getParsedId

public String getParsedId()