Package com.iizix.text
Class KStringPLAINVirtualSpaceTag
- java.lang.Object
- com.iizix.text.KStringTag<TARGET>
- com.iizix.text.KStringPLAINTag<VSField>
- com.iizix.text.KStringPLAINVirtualSpaceTag
 
 
 
- All Implemented Interfaces:
- IKStringTextTag,- java.lang.Cloneable
 - public class KStringPLAINVirtualSpaceTag extends KStringPLAINTag<VSField> implements IKStringTextTag Class for the VirtualSpace tag for KString that is of type PLAIN.- Author:
- Christopher Mindus
 
- Nested Class Summary- Nested classes/interfaces inherited from class com.iizix.text.KStringTag- KStringTag.Type
 
 - Field Summary- Fields inherited from class com.iizix.text.KStringPLAINTag- ref
 
 - Constructor Summary- Constructors - Constructor - Description - KStringPLAINVirtualSpaceTag(java.lang.String ref, java.lang.String inputString, int position, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes)Creates a VirtualSpace tag for KString that is of type PLAIN.
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - java.lang.String- getHTMLString(java.lang.StringBuilder useme, IKStringInfoProvider provider)Gets the string representation of this tag in the HTML format, i.e.- java.lang.String- getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)Gets the string representation of this tag in the PLAIN format.- java.lang.Class<?>- getReferenceClass()Returns the reference class used by this tag, e.g.- boolean- isReferenceValid(KStringHolder holder, GProp<?> gp)Validates a reference.- boolean- isRefreshRequired(GEvent event, VSField field)Upon a property event received on the target reference property (or its children), this method verifies if the event would affect the KString contents needing to be refreshed.- Methods inherited from class com.iizix.text.KStringPLAINTag- equalsName, getHTMLTagText, getPLAINTagText, getReference, isReferenceTag, setReference, willLoseFormatting
 - Methods inherited from class com.iizix.text.KStringTag- appendHTMLAttributes, appendHTMLAttributes, appendHTMLAttributesSkip, appendPLAINAttributes, appendPLAINValue, clone, disposeTagReference, equals, getAttribute, getReferenceDescription, getReferenceError, getSourceEndPosition, getSourceLength, getSourcePosition, getType, isRefreshRequired, resolve, setAttribute, setSourceLocation, verify
 - Methods inherited from class java.lang.Object- finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - Methods inherited from interface com.iizix.text.IKStringTextTag- getAttribute, getReference, getSourceEndPosition, getSourcePosition, getType, setAttribute, setReference
 
 
- Constructor Detail- KStringPLAINVirtualSpaceTag- public KStringPLAINVirtualSpaceTag(java.lang.String ref, java.lang.String inputString, int position, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes) throws KStringParseExceptionCreates a VirtualSpace tag for KString that is of type PLAIN.- Parameters:
- ref- The reference value.
- inputString- The input string.
- position- The position in the character based and parsed string.
- attributes- The attributes for the tag.
- Throws:
- KStringParseException
 
 
 - Method Detail- getReferenceClass- public java.lang.Class<?> getReferenceClass() Returns the reference class used by this tag, e.g. KStringProp for text table, or the image class IImageTarget.class.- Overrides:
- getReferenceClassin class- KStringTag<VSField>
- Returns:
- VSField.class.
 
 - getPLAINString- public java.lang.String getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)Gets the string representation of this tag in the PLAIN format.- Specified by:
- getPLAINStringin class- KStringTag<VSField>
- Parameters:
- useme- Temporary StringBuilder for any use.
- provider- The information provider or null for none.
 
 - getHTMLString- public java.lang.String getHTMLString(java.lang.StringBuilder useme, IKStringInfoProvider provider)Gets the string representation of this tag in the HTML format, i.e. return the text table item escaped for HTML.- Specified by:
- getHTMLStringin class- KStringTag<VSField>
- Parameters:
- useme- Temporary StringBuilder for any use.
- provider- The information provider or null for none.
 
 - isReferenceValid- public boolean isReferenceValid(KStringHolder holder, GProp<?> gp) Validates a reference.- Overrides:
- isReferenceValidin class- KStringTag<VSField>
- Parameters:
- holder- The KString holder.
- gp- The reference found.
- Returns:
- Validates the reference.
 
 - isRefreshRequired- public boolean isRefreshRequired(GEvent event, VSField field) Upon a property event received on the target reference property (or its children), this method verifies if the event would affect the KString contents needing to be refreshed.- Overrides:
- isRefreshRequiredin class- KStringTag<VSField>
- Parameters:
- event- The event.
- field- The target property for the tag.
- Returns:
- true to refresh the KString, false not to.