Package com.iizix.text
Interface IKStringValuePropHolder<PROP_VALUE>
- Type Parameters:
PROP_VALUE- The property value, e.g. KString, KTooltip or GBadge.
- All Superinterfaces:
IGProp<PROP_VALUE>,IKStringHolder<PROP_VALUE>,IKStringInfoProvider,ITextExternalizableProp<PROP_VALUE>
- All Known Implementing Classes:
BadgeProp,KStringProp,PatternProp,PlainKStringProp,TooltipProp
public interface IKStringValuePropHolder<PROP_VALUE> extends IKStringHolder<PROP_VALUE>, IKStringInfoProvider, ITextExternalizableProp<PROP_VALUE>
Interface containing default code for the KString holder, KString information provider and externalizable KString support.- Author:
- Christopher Mindus
Field Summary
Fields inherited from interface com.iizix.prop.IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default booleandoAddReference()Gets the flag for adding the reference string in an attribute when editing the KString in a rich text editor.default doublegetDPR()Gets the device pixel ratio.default KStringgetExternalizableKString()Returns if KString if it is a candidate for externalizing its text to a text table.default java.lang.StringgetHTTPServer()Gets the HTTP Server string prefix including port.default IImageTargetgetImageTarget(java.lang.String ref)Gets the image reference.default GProp<?>getResolveReferenceProperty()Gets the property used for references look-up's.default java.lang.StringgetResourcePrefix()Gets the base reference name for the resource, typically an image, for the Server or the Designer.default java.lang.StringgetTargetLanguageCode()Gets the language code to use.default booleaninstallFont(java.lang.String fontFamily)Installs the font families as specified by the font family.default booleaninstallFonts(java.util.List<FontFiles> fontList)Installs the font face as specified by theFontFilesinstance for the Client Session.default booleanshouldResolve()Flag indicating the "real" resolved string should be returned.Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning
Methods inherited from interface com.iizix.text.IKStringHolder
getKString, onKStringRefactored, resolveKStrings
Methods inherited from interface com.iizix.text.IKStringInfoProvider
installFonts
Methods inherited from interface com.iizix.text.ITextExternalizableProp
createNewPropValue
Method Detail
getHTTPServer
default java.lang.String getHTTPServer()
Gets the HTTP Server string prefix including port.- Specified by:
getHTTPServerin interfaceIKStringInfoProvider- Returns:
- The "HTTP[S]//server[:port]" String or null for none.
getImageTarget
default IImageTarget getImageTarget(java.lang.String ref)
Gets the image reference.- Specified by:
getImageTargetin interfaceIKStringInfoProvider- Parameters:
ref- The image definition reference string.- Returns:
- The image found, or null if not found.
doAddReference
default boolean doAddReference()
Gets the flag for adding the reference string in an attribute when editing the KString in a rich text editor.- Specified by:
doAddReferencein interfaceIKStringInfoProvider- Returns:
- true for the Designer (will add additional parameters for the rich text editor), false for normal processing.
shouldResolve
default boolean shouldResolve()
Flag indicating the "real" resolved string should be returned. This value is true for the runtime client when in "real run mode".- Specified by:
shouldResolvein interfaceIKStringInfoProvider- Returns:
- true to resolve all references, false if inside e.g. the Designer.
getResolveReferenceProperty
default GProp<?> getResolveReferenceProperty()
Gets the property used for references look-up's.- Specified by:
getResolveReferencePropertyin interfaceIKStringInfoProvider- Returns:
- The property to use for reference property look-up.
getDPR
default double getDPR()
Gets the device pixel ratio.- Specified by:
getDPRin interfaceIKStringInfoProvider- Returns:
- The device pixel ratio, default 1.0.
getTargetLanguageCode
default java.lang.String getTargetLanguageCode()
Gets the language code to use.- Specified by:
getTargetLanguageCodein interfaceIKStringInfoProvider- Returns:
- The language code, or null for default.
getResourcePrefix
default java.lang.String getResourcePrefix()
Gets the base reference name for the resource, typically an image, for the Server or the Designer. This reference is "/$" (the default in this interface) for the Designer, but should be "/$APPID/" for the Server, where APPID is the application being run by the client. The Server must therefore implement this method and return that string instead.- Specified by:
getResourcePrefixin interfaceIKStringInfoProvider- Returns:
- The resource prefix string, "/$" by default, but "/$APPID/" for the Server,' where APPID is the application being run by the client.
installFont
default boolean installFont(java.lang.String fontFamily)
Installs the font families as specified by the font family.- Specified by:
installFontin interfaceIKStringInfoProvider- Parameters:
fontFamily- The font family or families.- Returns:
- true for success, false if the remote part doesn't support installation, e.g. in a preview browser.
installFonts
default boolean installFonts(java.util.List<FontFiles> fontList)
Installs the font face as specified by theFontFilesinstance for the Client Session. Once installed, the font family can be used.- Specified by:
installFontsin interfaceIKStringInfoProvider- Parameters:
fontList- The list of font files to install.- Returns:
- true for success, false if the remote part doesn't support installation, e.g. in a preview browser.
getExternalizableKString
default KString getExternalizableKString()
Returns if KString if it is a candidate for externalizing its text to a text table.- Specified by:
getExternalizableKStringin interfaceITextExternalizableProp<PROP_VALUE>- Returns:
- The KString that can be externalized, or null if not.