com.sencha.gxt.widget.core.client.form
Class FieldLabel.FieldLabelOptions

java.lang.Object
  extended by com.sencha.gxt.widget.core.client.form.FieldLabel.FieldLabelOptions
All Implemented Interfaces:
HasSafeHtml, HasHTML, HasText
Enclosing class:
FieldLabel

public class FieldLabel.FieldLabelOptions
extends java.lang.Object
implements HasHTML, HasSafeHtml

A set of configuration parameters for a FieldLabel.


Constructor Summary
FieldLabel.FieldLabelOptions()
           
 
Method Summary
 java.lang.String getContent()
          Returns the content of the label.
 java.lang.String getHTML()
           
 FormPanel.LabelAlign getLabelAlign()
          Returns the justification of a field label inside its available space.
 int getLabelPad()
          Returns the width of the padding between the label and the control to which the label applies.
 java.lang.String getLabelSeparator()
          Returns the string to use as a suffix on the label to separate it from the field it labels.
 int getLabelWidth()
          Returns the width of area available for label text.
 java.lang.String getText()
           
 boolean isHtmlContent()
          Returns true if the content should be treated as HTML markup.
 void setHTML(SafeHtml html)
           
 void setHTML(java.lang.String html)
           
 void setLabelAlign(FormPanel.LabelAlign labelAlign)
          Sets the justification of a field label inside its available space.
 void setLabelPad(int labelPad)
          Sets the width of the padding between the label and the control to which the label applies.
 void setLabelSeparator(java.lang.String labelSeparator)
          Sets the string to use as a suffix on the label to separate it from the field it labels.
 void setLabelWidth(int labelWidth)
          Sets the width of area available for label text.
 void setText(java.lang.String text)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldLabel.FieldLabelOptions

public FieldLabel.FieldLabelOptions()
Method Detail

getContent

public java.lang.String getContent()
Returns the content of the label. This string represents the text content of the label or HTML to be rendered in the label space depending on the value of htmlContent.

Returns:
the content of the label

getHTML

public java.lang.String getHTML()
Specified by:
getHTML in interface HasHTML

getLabelAlign

public FormPanel.LabelAlign getLabelAlign()
Returns the justification of a field label inside its available space.

Returns:
the justification of a field label inside its available space

getLabelPad

public int getLabelPad()
Returns the width of the padding between the label and the control to which the label applies.

Returns:
the width of the padding between the label and the control to which the label applies

getLabelSeparator

public java.lang.String getLabelSeparator()
Returns the string to use as a suffix on the label to separate it from the field it labels.

Returns:
the string to use as a suffix on the label to separate it from the field it labels

getLabelWidth

public int getLabelWidth()
Returns the width of area available for label text.

Returns:
the width of area available for label text

getText

public java.lang.String getText()
Specified by:
getText in interface HasText

isHtmlContent

public boolean isHtmlContent()
Returns true if the content should be treated as HTML markup. This is set depending on whether setText(String) or setHTML(String) was last called.

Returns:
true if content should be treated as HTML markup.

setHTML

public void setHTML(SafeHtml html)
Specified by:
setHTML in interface HasSafeHtml

setHTML

public void setHTML(java.lang.String html)
Specified by:
setHTML in interface HasHTML

setLabelAlign

public void setLabelAlign(FormPanel.LabelAlign labelAlign)
Sets the justification of a field label inside its available space.

Parameters:
labelAlign - the justification of a field label inside its available space

setLabelPad

public void setLabelPad(int labelPad)
Sets the width of the padding between the label and the control to which the label applies.

Parameters:
labelPad - the width of the padding between the label and the control to which the label applies

setLabelSeparator

public void setLabelSeparator(java.lang.String labelSeparator)
Sets the string to use as a suffix on the label to separate it from the field it labels.

Parameters:
labelSeparator - the string to use as a suffix on the label to separate it from the field it labels

setLabelWidth

public void setLabelWidth(int labelWidth)
Sets the width of area available for label text.

Parameters:
labelWidth - the width of area available for label text

setText

public void setText(java.lang.String text)
Specified by:
setText in interface HasText


Copyright © 2012. All Rights Reserved.