ro.sync.ecss.component.validation

Class AuthorDocumentPositionedInfo

java.lang.Object

ro.sync.document.DocumentPositionedInfo

ro.sync.ecss.component.validation.AuthorDocumentPositionedInfo

@API(type=EXTENDABLE,
     src=PUBLIC)
public class AuthorDocumentPositionedInfo
extends DocumentPositionedInfo

A document position info usually needs a line and column for the error. This extension allows you to specify either the problem AuthorNode or an offset/length interval in the Author content.

Field Summary

Fields

Modifier and Type	Field and Description
static ro.sync.document.DPIData	CONTENT_DATA Marks in the DPI that the offset is from the Author content

Fields inherited from class ro.sync.document.DocumentPositionedInfo

MESSAGE_CSS_STYLE, NOT_KNOWN, SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO, SEVERITY_WARN

Constructor Summary

Constructors

Constructor and Description
AuthorDocumentPositionedInfo(int severity, java.lang.String message, java.lang.String systemID, AuthorNode node) Constructor.
AuthorDocumentPositionedInfo(int severity, java.lang.String message, java.lang.String systemID, int startOffset, int length) Constructor.

Method Summary

Modifier and Type	Method and Description
AuthorNode	getNode()
boolean	isSelectEntireNode() Checks if the entire node should be selected.
void	setSelectEntireNode(boolean selectEntireNode) Sets if the entire node should be selected or not.

Methods inherited from class ro.sync.document.DocumentPositionedInfo

asHTML, asHTML, asText, asText, asXML, asXML, equals, flipSeverity, getAdditionalHtmlContent, getAdditionalInfo, getAnchor, getColumn, getData, getDITAAdditionalInfo, getECAdditionalInfo, getEndColumn, getEndLine, getEngineName, getErrorKey, getHTMLMessage, getImposedInitialPage, getLength, getLine, getMatchRange, getMessage, getMessageHighlightOffset, getMessageProvider, getMessageWithEngine, getMessageWithSeverity, getMessageWithSeverity, getOffset, getOperationDescription, getPreferredEngineName, getSeverity, getSeverityAsString, getStartEndPositions, getSystemID, hashCode, isElementTarget, isHighlightToColumn, setAdditionalInfo, setAnchor, setColumn, setData, setDITAAdditionalInfo, setECAdditionalInfo, setElementTarget, setEndColumn, setEndLine, setEngineName, setErrorKey, setHighlightToColumn, setHtmlMessageFragment, setImposedInitialPage, setLength, setLine, setMaskPasswordsInURLs, setMatchRange, setMessage, setMessageHighlightOffset, setOffset, setOperationDescription, setSeverity, setSystemID, setTemporaryPositions, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_DATA

public static ro.sync.document.DPIData CONTENT_DATA

Marks in the DPI that the offset is from the Author content

Constructor Detail

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(int severity,
                                    java.lang.String message,
                                    java.lang.String systemID,
                                    AuthorNode node)

Constructor.

Parameters:

severity - Severity. One of the severity constants from class DocumentPositionedInfo: SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO , SEVERITY_WARN.

message - Error message.

systemID - System ID

node - The author node.

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(int severity,
                                    java.lang.String message,
                                    java.lang.String systemID,
                                    int startOffset,
                                    int length)

Constructor.

Parameters:

severity - Severity. One of the severity constants from class DocumentPositionedInfo: SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO , SEVERITY_WARN.

message - Error message.

systemID - System ID

startOffset - The start offset of the problem, mapped in the Author content.

length - The length of the problem, mapped in the Author content.

Method Detail

getNode

public AuthorNode getNode()

Returns:

The node to locate the message.

setSelectEntireNode

public void setSelectEntireNode(boolean selectEntireNode)

Sets if the entire node should be selected or not.

Parameters:

selectEntireNode - true if the entire node should be selected.

isSelectEntireNode

public boolean isSelectEntireNode()

Checks if the entire node should be selected.

Returns:

true if the entire node should be selected.