|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eml.MMAX2.annotation.markables.Markable
public final class Markable
Constructor Summary | |
---|---|
Markable(org.w3c.dom.Node _nodeRepresentation,
java.lang.String _ID,
java.lang.String[][] _fragments,
java.util.HashMap _attributes,
MarkableLevel _level)
Creates new Markable. |
Method Summary | |
---|---|
boolean |
addDiscourseElements(java.lang.String[] addees)
|
void |
addLeftHandlePosition(int pos)
|
void |
addRightHandlePosition(int pos)
|
void |
clearMarkableHandles()
|
Markable |
cloneMarkable()
|
boolean |
coversDisplayPosition(int displayPosition)
This method returns true if displayPosition is covered by the Markable, false otherwise. |
void |
deleteMe()
|
void |
destroyDependentComponents()
|
javax.swing.text.SimpleAttributeSet |
getAttributedependentStyle()
|
java.util.HashMap |
getAttributes()
This method returns all of this Markable's attributes (except ID and SPAN, which are system-attributes) as a HashMap. |
java.lang.String |
getAttributeValue(java.lang.String attributeName)
This method returns the value this Markable has for attribute attributeName, or null if attribute is not defined for Markable. |
java.lang.String |
getAttributeValue(java.lang.String name,
java.lang.String defaultIfUndefined)
(API) Returns the string value of this Markable's attribute, or returnIfUndefined if attribute is undefined for this Markable. |
java.lang.String[] |
getDiscourseElementIDs()
|
java.lang.String[] |
getDiscourseElements()
|
int[] |
getDiscourseElementStartPositions()
|
int[] |
getDisplayEndPositions()
|
int[] |
getDisplayStartPositions()
|
java.lang.String[][] |
getFragments()
|
java.lang.String |
getID()
(API) Returns the ID string of this Markable, e.g. |
boolean |
getIsInSearchResult()
|
int[] |
getLeftHandlePositions()
|
int |
getLeftmostDiscoursePosition()
(API) Returns the discourse position of the leftmost MMAX2DiscourseElement that this Markable object contains. |
int |
getLeftmostDisplayPosition()
|
MarkableLevel |
getMarkableLevel()
(API) Returns the MarkableLevel object that this Markable belongs to. |
java.lang.String |
getMarkableLevelName()
|
org.w3c.dom.Node |
getNodeRepresentation()
|
java.awt.Point |
getPoint()
|
int[] |
getRightHandlePositions()
|
int |
getRightmostDiscoursePosition()
(API) Returns the discourse position of the rightmost MMAX2DiscourseElement that this Markable object contains. |
int |
getRightmostDisplayPosition()
|
int |
getSize()
|
MMAX2Attribute[] |
getValidatedAttributes()
This does return attributes only, values are changed back immediately afterwards!! (Used for creation of ActionSelector) Important: This does NOT make sure to set the attribute window to prior display state!! |
boolean |
isDefined(java.lang.String attributeName)
This method returns true if an attribute with name attributeName is defined for this Markable, i.e. |
boolean |
isDiscontinuous()
|
void |
removeAttribute(java.lang.String attributeName)
|
boolean |
removeDiscourseElements(java.lang.String[] removees)
|
void |
renderMe(int mode)
|
void |
selectMe()
|
void |
setAttributes(java.util.HashMap newAttributes)
|
void |
setAttributeValue(java.lang.String attributeName,
java.lang.String value)
(API) Sets this markable's attribute to value. |
void |
setAttributeValueToNode(java.lang.String attributeName,
java.lang.String value)
|
void |
setIsInSearchResult(boolean status)
|
java.lang.String |
toString()
(API) Returns the string representation of this Markable object. |
java.lang.String |
toTrimmedString(int maxLen)
(API) Returns the trimmed string representation of this Markable object. |
void |
update(java.lang.String[][] _fragments)
This method is called on each markable after a change in the base data |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Markable(org.w3c.dom.Node _nodeRepresentation, java.lang.String _ID, java.lang.String[][] _fragments, java.util.HashMap _attributes, MarkableLevel _level)
Method Detail |
---|
public final void clearMarkableHandles()
public final void update(java.lang.String[][] _fragments)
public final java.lang.String toString()
MarkableAPI
toString
in interface MarkableAPI
toString
in class java.lang.Object
public final java.lang.String[] getDiscourseElements()
public final java.lang.String[] getDiscourseElementIDs()
public final boolean removeDiscourseElements(java.lang.String[] removees)
public final boolean addDiscourseElements(java.lang.String[] addees)
public final void deleteMe()
public final javax.swing.text.SimpleAttributeSet getAttributedependentStyle()
public final void destroyDependentComponents()
public final int getLeftmostDiscoursePosition()
MarkableAPI
MMAX2DiscourseElement
that this Markable object contains.
getLeftmostDiscoursePosition
in interface MarkableAPI
MMAX2DiscourseElement
that this Markable object contains. The discourse position is normally the base data element's position in the base data file.public final int getRightmostDiscoursePosition()
MarkableAPI
MMAX2DiscourseElement
that this Markable object contains.
getRightmostDiscoursePosition
in interface MarkableAPI
MMAX2DiscourseElement
that this Markable object contains. The discourse position is normally the base data element's position in the base data file.public final int getLeftmostDisplayPosition()
public final int getRightmostDisplayPosition()
public final int[] getDisplayStartPositions()
public final int[] getDisplayEndPositions()
public final int[] getDiscourseElementStartPositions()
public final void renderMe(int mode)
public final boolean isDiscontinuous()
public final int getSize()
public final void addLeftHandlePosition(int pos)
public final int[] getLeftHandlePositions()
public final void addRightHandlePosition(int pos)
public final int[] getRightHandlePositions()
public final org.w3c.dom.Node getNodeRepresentation()
public final java.lang.String getID()
MarkableAPI
getID
in interface MarkableAPI
public final java.lang.String getMarkableLevelName()
public final MarkableLevel getMarkableLevel()
MarkableAPI
getMarkableLevel
in interface MarkableAPI
MarkableLevel
that this Markable belongs to.public final MMAX2Attribute[] getValidatedAttributes()
public final boolean coversDisplayPosition(int displayPosition)
public final java.lang.String[][] getFragments()
public final boolean getIsInSearchResult()
public final void setIsInSearchResult(boolean status)
public java.lang.String toTrimmedString(int maxLen)
MarkableAPI
toTrimmedString
in interface MarkableAPI
maxLen
- The maximum string width to return.
public final java.awt.Point getPoint()
public final java.util.HashMap getAttributes()
public final void setAttributes(java.util.HashMap newAttributes)
public final void selectMe()
public final java.lang.String getAttributeValue(java.lang.String attributeName)
public final java.lang.String getAttributeValue(java.lang.String name, java.lang.String defaultIfUndefined)
MarkableAPI
getAttributeValue
in interface MarkableAPI
name
- The name of the attribute whose value to return.defaultIfUndefined
- The string to return if attribute is undefined.
public final void setAttributeValue(java.lang.String attributeName, java.lang.String value)
MarkableAPI
setAttributeValue
in interface MarkableAPI
attributeName
- The attribute whose value to set.value
- The value to assign to the attribute.public final void setAttributeValueToNode(java.lang.String attributeName, java.lang.String value)
public final void removeAttribute(java.lang.String attributeName)
public final boolean isDefined(java.lang.String attributeName)
public final Markable cloneMarkable()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |