1. /*

  2.  * @(#)RTFAttributes.java	1.8 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. package javax.swing.text.rtf;

  11. 

  12. import javax.swing.text.StyleConstants;

  13. import javax.swing.text.AttributeSet;

  14. import javax.swing.text.MutableAttributeSet;

  15. import javax.swing.text.TabStop;

  16. import java.util.*;

  17. import java.io.IOException;

  18. 

  19. class RTFAttributes

  20. {

  21.     static RTFAttribute attributes[];

  22. 

  23.     static {

  24.         Vector a = new Vector();

  25. 	int CHR = RTFAttribute.D_CHARACTER;

  26. 	int PGF = RTFAttribute.D_PARAGRAPH;

  27. 	int SEC = RTFAttribute.D_SECTION;

  28. 	int DOC = RTFAttribute.D_DOCUMENT;

  29. 	int PST = RTFAttribute.D_META;

  30. 	Boolean True = new Boolean(true);

  31. 	Boolean False = new Boolean(false);

  32. 

  33. 	a.addElement(new BooleanAttribute(CHR, StyleConstants.Italic, "i"));

  34. 	a.addElement(new BooleanAttribute(CHR, StyleConstants.Bold, "b"));

  35. 	a.addElement(new BooleanAttribute(CHR, StyleConstants.Underline, "ul"));

  36. 	a.addElement(NumericAttribute.NewTwips(PGF, StyleConstants.LeftIndent, "li",

  37. 					0f, 0));

  38. 	a.addElement(NumericAttribute.NewTwips(PGF, StyleConstants.RightIndent, "ri",

  39. 					0f, 0));

  40. 	a.addElement(NumericAttribute.NewTwips(PGF, StyleConstants.FirstLineIndent, "fi",

  41. 					0f, 0));

  42. 

  43. 	a.addElement(new AssertiveAttribute(PGF, StyleConstants.Alignment,

  44. 					    "ql", StyleConstants.ALIGN_LEFT));

  45. 	a.addElement(new AssertiveAttribute(PGF, StyleConstants.Alignment,

  46. 					    "qr", StyleConstants.ALIGN_RIGHT));

  47. 	a.addElement(new AssertiveAttribute(PGF, StyleConstants.Alignment,

  48. 					    "qc", StyleConstants.ALIGN_CENTER));

  49. 	a.addElement(new AssertiveAttribute(PGF, StyleConstants.Alignment,

  50. 					    "qj", StyleConstants.ALIGN_JUSTIFIED));

  51. 	a.addElement(NumericAttribute.NewTwips(PGF, StyleConstants.SpaceAbove,

  52. 					"sa", 0));

  53. 	a.addElement(NumericAttribute.NewTwips(PGF, StyleConstants.SpaceBelow,

  54. 					"sb", 0));

  55. 

  56. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabAlignmentKey,

  57. 					    "tqr", TabStop.ALIGN_RIGHT));

  58. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabAlignmentKey,

  59. 					    "tqc", TabStop.ALIGN_CENTER));

  60. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabAlignmentKey,

  61. 					    "tqdec", TabStop.ALIGN_DECIMAL));

  62. 		     

  63. 

  64. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabLeaderKey,

  65. 					    "tldot", TabStop.LEAD_DOTS));

  66. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabLeaderKey,

  67. 					    "tlhyph", TabStop.LEAD_HYPHENS));

  68. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabLeaderKey,

  69. 					    "tlul", TabStop.LEAD_UNDERLINE));

  70. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabLeaderKey,

  71. 					    "tlth", TabStop.LEAD_THICKLINE));

  72. 	a.addElement(new AssertiveAttribute(PST, RTFReader.TabLeaderKey,

  73. 					    "tleq", TabStop.LEAD_EQUALS));

  74. 

  75. 	/* The following aren't actually recognized by Swing */

  76. 	a.addElement(new BooleanAttribute(CHR, Constants.Caps,      "caps"));

  77. 	a.addElement(new BooleanAttribute(CHR, Constants.Outline,   "outl"));

  78. 	a.addElement(new BooleanAttribute(CHR, Constants.SmallCaps, "scaps"));

  79. 	a.addElement(new BooleanAttribute(CHR, Constants.Shadow,    "shad"));

  80. 	a.addElement(new BooleanAttribute(CHR, Constants.Hidden,    "v"));

  81. 	a.addElement(new BooleanAttribute(CHR, Constants.Strikethrough,

  82. 					       "strike"));

  83. 	a.addElement(new BooleanAttribute(CHR, Constants.Deleted,

  84. 					       "deleted"));

  85. 

  86. 

  87. 	

  88. 	a.addElement(new AssertiveAttribute(DOC, "saveformat", "defformat", "RTF"));

  89. 	a.addElement(new AssertiveAttribute(DOC, "landscape", "landscape"));

  90. 

  91. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.PaperWidth,

  92. 					       "paperw", 12240));

  93. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.PaperHeight,

  94. 					       "paperh", 15840));

  95. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.MarginLeft,

  96. 					       "margl",  1800));

  97. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.MarginRight,

  98. 					       "margr",  1800));

  99. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.MarginTop,

  100. 					       "margt",  1440));

  101. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.MarginBottom,

  102. 					       "margb",  1440));

  103. 	a.addElement(NumericAttribute.NewTwips(DOC, Constants.GutterWidth,

  104. 					       "gutter", 0));

  105. 

  106. 	a.addElement(new AssertiveAttribute(PGF, Constants.WidowControl,

  107. 					    "nowidctlpar", False));

  108. 	a.addElement(new AssertiveAttribute(PGF, Constants.WidowControl,

  109. 					    "widctlpar", True));

  110. 	a.addElement(new AssertiveAttribute(DOC, Constants.WidowControl,

  111. 					    "widowctrl", True));

  112. 	

  113. 

  114. 	RTFAttribute[] attrs = new RTFAttribute[a.size()];

  115. 	a.copyInto(attrs);

  116. 	attributes = attrs;

  117.     }	

  118. 

  119.     static Dictionary attributesByKeyword()

  120.     {

  121.         Dictionary d = new Hashtable(attributes.length);

  122. 	int i, m;

  123. 

  124. 	m = attributes.length;

  125. 	for(i = 0; i < m; i++)

  126. 	    d.put(attributes[i].rtfName(), attributes[i]);

  127. 

  128. 	return d;

  129.     }

  130. 

  131.     /************************************************************************/

  132.     /************************************************************************/

  133. 

  134.     static abstract class GenericAttribute 

  135.     {

  136.         int domain;

  137. 	Object swingName;

  138. 	String rtfName;

  139. 	

  140. 	protected GenericAttribute(int d,Object s, String r)

  141. 	{

  142. 	    domain = d;

  143. 	    swingName = s;

  144. 	    rtfName = r;

  145. 	}

  146. 

  147. 	public int domain() { return domain; }

  148. 	public Object swingName() { return swingName; }

  149. 	public String rtfName() { return rtfName; }

  150. 	

  151. 	abstract boolean set(MutableAttributeSet target);

  152. 	abstract boolean set(MutableAttributeSet target, int parameter);

  153. 	abstract boolean setDefault(MutableAttributeSet target);

  154. 	

  155. 	public boolean write(AttributeSet source,

  156. 			     RTFGenerator target,

  157. 			     boolean force)

  158. 	    throws IOException

  159. 	{

  160. 	    return writeValue(source.getAttribute(swingName), target, force);

  161. 	}

  162. 

  163. 	public boolean writeValue(Object value, RTFGenerator target,

  164. 				  boolean force)

  165. 	    throws IOException 

  166. 	{

  167. 	    return false;

  168. 	}

  169.     }

  170. 

  171.     static class BooleanAttribute 

  172.         extends GenericAttribute

  173. 	implements RTFAttribute

  174.     {

  175.         boolean rtfDefault;

  176. 	boolean swingDefault;

  177. 

  178. 	protected static final Boolean True = new Boolean(true);

  179. 	protected static final Boolean False = new Boolean(false);

  180. 	

  181. 	public BooleanAttribute(int d, Object s,

  182. 				String r, boolean ds, boolean dr)

  183. 	{

  184. 	    super(d, s, r);

  185. 	    swingDefault = ds;

  186. 	    rtfDefault = dr;

  187. 	}

  188. 

  189. 	public BooleanAttribute(int d, Object s, String r)

  190. 	{

  191. 	    super(d, s, r);

  192. 	    

  193. 	    swingDefault = false;

  194. 	    rtfDefault = false;

  195. 	}

  196. 

  197. 	public boolean set(MutableAttributeSet target)

  198. 	{

  199. 	    /* TODO: There's some ambiguity about whenther this should

  200. 	       *set* or *toggle* the attribute. */

  201. 	    target.addAttribute(swingName, True);

  202. 

  203. 	    return true;  /* true indicates we were successful */

  204. 	}

  205. 

  206. 	public boolean set(MutableAttributeSet target, int parameter)

  207. 	{

  208. 	    /* See above note in the case that parameter==1 */

  209. 	    Boolean value = ( parameter != 0 ? True : False );

  210. 	    

  211. 	    target.addAttribute(swingName, value);

  212. 	    

  213. 	    return true; /* true indicates we were successful */

  214. 	}

  215. 	

  216. 	public boolean setDefault(MutableAttributeSet target)

  217. 	{

  218. 	    if (swingDefault != rtfDefault ||

  219. 		( target.getAttribute(swingName) != null ) )

  220. 	      target.addAttribute(swingName, new Boolean(rtfDefault));

  221. 	    return true;

  222. 	}

  223. 

  224. 	public boolean writeValue(Object o_value,

  225. 				  RTFGenerator target,

  226. 				  boolean force)

  227. 	    throws IOException

  228. 	{

  229. 	    Boolean val;

  230. 

  231. 	    if (o_value == null)

  232. 	      val = new Boolean(swingDefault);

  233. 	    else

  234. 	      val = (Boolean)o_value;

  235. 	    

  236. 	    if (force || (val.booleanValue() != rtfDefault)) {

  237. 		if (val.booleanValue()) {

  238. 		    target.writeControlWord(rtfName);

  239. 		} else {

  240. 		    target.writeControlWord(rtfName, 0);

  241. 		}

  242. 	    }

  243. 	    return true;

  244. 	}

  245.     }

  246. 

  247. 

  248.     static class AssertiveAttribute

  249.         extends GenericAttribute

  250. 	implements RTFAttribute

  251.     {

  252. 	Object swingValue;

  253. 

  254. 	public AssertiveAttribute(int d, Object s, String r)

  255. 	{

  256. 	    super(d, s, r);

  257. 	    swingValue = new Boolean(true);

  258. 	}

  259. 

  260. 	public AssertiveAttribute(int d, Object s, String r, Object v)

  261. 	{

  262. 	    super(d, s, r);

  263. 	    swingValue = v;

  264. 	}

  265. 

  266. 	public AssertiveAttribute(int d, Object s, String r, int v)

  267. 	{

  268. 	    super(d, s, r);

  269. 	    swingValue = new Integer(v);

  270. 	}

  271. 	

  272. 	public boolean set(MutableAttributeSet target)

  273. 	{

  274. 	    if (swingValue == null)

  275. 	        target.removeAttribute(swingName);

  276. 	    else

  277. 	        target.addAttribute(swingName, swingValue);

  278. 	    

  279. 	    return true;

  280. 	}

  281.     

  282. 	public boolean set(MutableAttributeSet target, int parameter)

  283. 	{

  284. 	    return false;

  285. 	}

  286.     

  287. 	public boolean setDefault(MutableAttributeSet target)

  288. 	{

  289. 	    target.removeAttribute(swingName);

  290. 	    return true;

  291. 	}

  292. 

  293. 	public boolean writeValue(Object value,

  294. 				  RTFGenerator target,

  295. 				  boolean force)

  296. 	    throws IOException

  297.         {

  298. 	    if (value == null) {

  299. 		return ! force;

  300. 	    }

  301. 

  302. 	    if (value.equals(swingValue)) {

  303. 		target.writeControlWord(rtfName);

  304. 		return true;

  305. 	    }

  306. 	    

  307. 	    return ! force;

  308. 	}

  309.     }

  310. 

  311. 

  312.     static class NumericAttribute 

  313.         extends GenericAttribute

  314. 	implements RTFAttribute

  315.     {

  316. 	int rtfDefault;

  317. 	Number swingDefault;

  318. 	float scale;

  319. 	

  320. 	protected NumericAttribute(int d, Object s, String r)

  321. 	{

  322. 	    super(d, s, r);

  323. 	    rtfDefault = 0;

  324. 	    swingDefault = null;

  325. 	    scale = 1f;

  326. 	}

  327. 

  328. 	public NumericAttribute(int d, Object s,

  329. 				String r, int ds, int dr)

  330. 	{

  331. 	    this(d, s, r, new Integer(ds), dr, 1f);

  332. 	}

  333. 

  334. 	public NumericAttribute(int d, Object s,

  335. 				String r, Number ds, int dr, float sc)

  336. 	{

  337. 	    super(d, s, r);

  338. 	    swingDefault = ds;

  339. 	    rtfDefault = dr;

  340. 	    scale = sc;

  341. 	}

  342. 

  343. 	public static NumericAttribute NewTwips(int d, Object s, String r,

  344. 						float ds, int dr)

  345. 	{

  346. 	    return new NumericAttribute(d, s, r, new Float(ds), dr, 20f);

  347. 	}

  348. 

  349. 	public static NumericAttribute NewTwips(int d, Object s, String r,

  350. 						int dr)

  351. 	{

  352. 	    return new NumericAttribute(d, s, r, null, dr, 20f);

  353. 	}

  354. 

  355. 	public boolean set(MutableAttributeSet target)

  356. 	{

  357. 	    return false;

  358. 	}

  359. 

  360. 	public boolean set(MutableAttributeSet target, int parameter)

  361. 	{

  362. 	    Number swingValue;

  363. 

  364. 	    if (scale == 1f)

  365. 	        swingValue = new Integer(parameter);

  366. 	    else

  367. 	        swingValue = new Float(parameter / scale);

  368. 	    target.addAttribute(swingName, swingValue);

  369. 	    return true;

  370. 	}

  371. 

  372. 	public boolean setDefault(MutableAttributeSet target)

  373. 	{

  374. 	    Number old = (Number)target.getAttribute(swingName);

  375. 	    if (old == null)

  376. 	        old = swingDefault;

  377. 	    if (old != null && (

  378. 		    (scale == 1f && old.intValue() == rtfDefault) ||

  379. 		    (Math.round(old.floatValue() * scale) == rtfDefault)

  380. 	       ))

  381. 	        return true;

  382. 	    set(target, rtfDefault);

  383. 	    return true;

  384. 	}

  385. 

  386. 	public boolean writeValue(Object o_value,

  387. 				  RTFGenerator target,

  388. 				  boolean force)

  389. 	    throws IOException

  390. 	{

  391. 	    Number value = (Number)o_value;

  392. 	    if (value == null)

  393. 	        value = swingDefault;

  394. 	    if (value == null) {

  395. 		/* TODO: What is the proper behavior if the Swing object does

  396. 		   not specify a value, and we don't know its default value?

  397. 		   Currently we pretend that the RTF default value is

  398. 		   equivalent (probably a workable assumption) */

  399. 		return true;

  400. 	    }

  401. 	    int int_value = Math.round(value.floatValue() * scale);

  402. 	    if (force || (int_value != rtfDefault))

  403. 	        target.writeControlWord(rtfName, int_value);

  404. 	    return true;

  405. 	}

  406.     }

  407. }