com.ibm.tivoli.maximo.skd.applet.util

Class SKDBidiUtil

java.lang.Object

com.ibm.tivoli.maximo.skd.applet.util.SKDBidiUtil

public class SKDBidiUtil
extends java.lang.Object

Simple BIDI utilities for the Applets. See the BIDI Direction Algorithm at http://www.unicode.org/reports/tr9/

Author:

sls

Constructor Summary

Constructors

Constructor and Description
SKDBidiUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addTooltipPair(java.util.List<java.lang.Object> pairs, java.lang.Object label, java.lang.Object data) Convenience method that will add the tooltip pair, even if the data value is null.
static void	addTooltipPair(java.util.List<java.lang.Object> pairs, java.lang.Object label, java.lang.Object data, boolean addOnlyIfDataNotNull) Simple convenience method to add 2 pieces of data (ie, a pair) to a List provided that the data is not null.
static java.lang.String	htmlTableTooltip(boolean bidiEnabled, boolean guiMirrorred, java.lang.String headerText, java.lang.String footerText, boolean boldLabels, java.lang.String separator, java.lang.Object... parts) Formats a tooltip as two column table layout where the first column is the Label and the second column is the description.
static java.lang.String	htmlTableTooltip(boolean boldLabels, java.lang.String separator, java.lang.Object... parts) Convenience method for creating html table tooltips that don't require a header or footer text
static java.lang.String	htmlTableTooltip(java.lang.String headerText, java.lang.String footerText, boolean boldLabels, java.lang.String separator, java.lang.Object... parts) Convenience method for creating html table tooltips that autodiscovers the BIDI and GUI mirrorred settings
static boolean	isRTL(java.lang.Object... parts) Given an array of objects return true if any objects are RTL strings
static boolean	isRTL(java.lang.String str) Return true if the string is a RTL string
static java.lang.String	join(java.lang.Object... parts) Convenience method for joining multiple strings using a null separator (ie, no separator) and it will use discover whether or not to use bidi enabled or not.
static java.lang.String	joinBIDIWith(boolean bidiEnalbed, java.lang.String sepString, java.lang.Object... parts) Joins multiple strings, applying a separactor string between them, if non null.
static java.lang.String	joinWith(java.lang.String sepString, java.lang.Object... parts) Convenience method that auto determines the bidi enabled setting.
static java.lang.String	toHTML(java.lang.String rtlString) Given a BIDI string (ie, string with BIDI control chars) convert it to an emulated bidi string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SKDBidiUtil

public SKDBidiUtil()

Method Detail

joinBIDIWith

public static java.lang.String joinBIDIWith(boolean bidiEnalbed,
                            java.lang.String sepString,
                            java.lang.Object... parts)

Joins multiple strings, applying a separactor string between them, if non null. If bidi is enabled, then the strings will have the appropriate RLE, RLM, and PDF control characters.
For example, if called as join(true, "-", "A',"B","C") then the output would look like

C-B-A
 
 
 while the unicode string would look like
 
 
 {8235}{65}{8207}{45}{8207}{66}{8207}{45}{8207}{67}{8236}
 
 
 

 

 if a null separator is passed in, then no separator will be used. 

 For example, if called as join(true, null, "A',"B","C") then the output would look like
 
 
CBA
 
 
 while the unicode string would look like
 
 
 {8235}{65}{8207}{66}{8207}{67}{8236}
 
 
 

 If bidi is not enabled the normal string concatenation rules applies the resulting string will contain NO unicode
 control characters. 

 For example, if called as join(false, "-", "A',"B","C") then the output would look like
 
 
A-B-C
 
 
 while the unicode string would look like
 
 
 {65}{66}{67}
 
 
 

Parameters:

bidiEnalbed - true if you want the string to contain RLE bidi control codes

sepString - if non null, then each part will be joined using this separator

parts - variable arg array of objects (usualy strings) that will be joined

Returns:

formatted string

joinWith

public static java.lang.String joinWith(java.lang.String sepString,
                        java.lang.Object... parts)

Convenience method that auto determines the bidi enabled setting. A use case might be

 String description = SKDBidiUtil.join("-", getAssetNum(), getAssetDescription());
 

This would join the asset num and the asset description using bidi control characters, IF bidi is required

Parameters:

sepString -

parts -

Returns:

join

public static java.lang.String join(java.lang.Object... parts)

Convenience method for joining multiple strings using a null separator (ie, no separator) and it will use discover whether or not to use bidi enabled or not. A use case might be something like

 String description = SKDBidiUtil.join(getAssetNum(), "-", getAssetDescription())
 

This would join the asset num , "-" and description using bidi control control characters if bidi is required.

Parameters:

parts -

Returns:

isRTL

public static boolean isRTL(java.lang.String str)

Return true if the string is a RTL string

Parameters:

str -

Returns:

true if string contains RTL characters

isRTL

public static boolean isRTL(java.lang.Object... parts)

Given an array of objects return true if any objects are RTL strings

Parameters:

parts -

Returns:

true if any object is a RTL string

htmlTableTooltip

public static java.lang.String htmlTableTooltip(boolean boldLabels,
                                java.lang.String separator,
                                java.lang.Object... parts)

Convenience method for creating html table tooltips that don't require a header or footer text

Parameters:

boldLabels -

separator -

parts -

Returns:

htmlTableTooltip

public static java.lang.String htmlTableTooltip(java.lang.String headerText,
                                java.lang.String footerText,
                                boolean boldLabels,
                                java.lang.String separator,
                                java.lang.Object... parts)

Convenience method for creating html table tooltips that autodiscovers the BIDI and GUI mirrorred settings

Parameters:

headerText -

footerText -

boldLabels -

separator -

parts -

Returns:

htmlTableTooltip

public static java.lang.String htmlTableTooltip(boolean bidiEnabled,
                                boolean guiMirrorred,
                                java.lang.String headerText,
                                java.lang.String footerText,
                                boolean boldLabels,
                                java.lang.String separator,
                                java.lang.Object... parts)

Formats a tooltip as two column table layout where the first column is the Label and the second column is the description. NOTE: Java HTML labels (ie, tooltips, etc), DO NOT SUPPORT bidi control characters. As a result bidi is required to be "emulated". This emulation involves having to manually layout the labels and data from RTL.

Parameters:

headerText - Optional header text to display above the paired data

footerText - Optional footer text to display below the paried data

boldLabels - if true, then the labels will bolded to stand out

separator - if set, then this will be added to the label

parts - Array data were every 2 elements is a row in the html tooltip

Returns:

toHTML

public static java.lang.String toHTML(java.lang.String rtlString)

Given a BIDI string (ie, string with BIDI control chars) convert it to an emulated bidi string. It will replace the BIDI control characters and then reorder the string to emulate BIDI. This is required becuse Swing's HTML control does not support bidi control characters. So, if you use a join() or joinWith() to create a bidi string, then it will not display correctly in html tooltip.

Parameters:

rtlString -

Returns:

addTooltipPair

public static void addTooltipPair(java.util.List<java.lang.Object> pairs,
                  java.lang.Object label,
                  java.lang.Object data)

Convenience method that will add the tooltip pair, even if the data value is null.

Parameters:

pairs -

label -

data -

addTooltipPair

public static void addTooltipPair(java.util.List<java.lang.Object> pairs,
                  java.lang.Object label,
                  java.lang.Object data,
                  boolean addOnlyIfDataNotNull)

Simple convenience method to add 2 pieces of data (ie, a pair) to a List provided that the data is not null.

Parameters:

pairs - List to which to add the label and data pair

label - data label

data - data value

addOnlyIfDataNotNull - when true, then the label/data pair will only be added if the data is not null