01: /*
02: * GWT-Ext Widget Library
03: * Copyright(c) 2007-2008, GWT-Ext.
04: * licensing@gwt-ext.com
05: *
06: * http://www.gwt-ext.com/license
07: */
08: package com.gwtext.client.widgets.layout;
09:
10: import com.gwtext.client.util.JavaScriptObjectHelper;
11:
12: /**
13: * Supporting class for {@link FormLayout}. Any type of components can be added to a FormLayout, but items that inherit from {@link com.gwtext.client.widgets.form.Field}
14: * can also supply the following field-specific config properties.
15: *
16: * @see com.gwtext.client.widgets.layout.FormLayout
17: */
18: public class FormLayoutData extends LayoutData {
19:
20: /**
21: * The CSS class to apply to the special clearing div rendered directly after each form field wrapper (defaults to 'x-form-clear-left')
22: *
23: * @param clearCls the CSS class to apply to the special clearing div rendered directly after each form field wrapper (defaults to 'x-form-clear-left')
24: */
25: public void setClearCls(String clearCls) {
26: JavaScriptObjectHelper
27: .setAttribute(jsObj, "clearCls", clearCls);
28: }
29:
30: /**
31: * The text to display as the label for this field (defaults to '')
32: *
33: * @param fieldLabel the text to display as the label for this field (defaults to '')
34: */
35: public void setFieldLabel(String fieldLabel) {
36: JavaScriptObjectHelper.setAttribute(jsObj, "fieldLabel",
37: fieldLabel);
38: }
39:
40: /**
41: * True to hide the label and separator for this field (defaults to false).
42: *
43: * @param hideLabel true to hide the label and separator for this field (defaults to false).
44: */
45: public void setHideLabel(boolean hideLabel) {
46: JavaScriptObjectHelper.setAttribute(jsObj, "hideLabel",
47: hideLabel);
48: }
49:
50: /**
51: * A CSS class to add to the div wrapper that contains this field label and field element
52: * (the default class is 'x-form-item' and itemCls will be added to that). If supplied, itemCls at the field level
53: * will override the default itemCls supplied at the container level.
54: *
55: * @param itemCls the item CSS class
56: */
57: public void setItemCls(String itemCls) {
58: JavaScriptObjectHelper.setAttribute(jsObj, "itemCls", itemCls);
59: }
60:
61: /**
62: * The separator to display after the text of the label for this field (defaults to a colon ':' or the layout's value for labelSeparator).
63: * To hide the separator use empty string ''.
64: *
65: * @param labelSeparator the label separator
66: */
67: public void setLabelSeparator(String labelSeparator) {
68: JavaScriptObjectHelper.setAttribute(jsObj, "labelSeparator",
69: labelSeparator);
70: }
71:
72: /**
73: * A CSS style specification string to add to the field label for this field (defaults to '' or the layout's value for labelStyle).
74: *
75: * @param labelStyle the label CSS style
76: */
77: public void setLabelStyle(String labelStyle) {
78: JavaScriptObjectHelper.setAttribute(jsObj, "labelStyle",
79: labelStyle);
80: }
81:
82: }
|