|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.Label
public class Label
Label component for showing non-editable short texts.
The label content can be set to the modes specified by ContentMode
The contents of the label may contain simple formatting:
Nested Class Summary | |
---|---|
static class |
Label.ValueChangeEvent
Value change event |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.data.Property |
---|
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeEvent, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Field Summary | |
---|---|
static ContentMode |
CONTENT_DEFAULT
Deprecated. From 7.0, use ContentMode.TEXT instead |
static ContentMode |
CONTENT_PREFORMATTED
Deprecated. From 7.0, use ContentMode.PREFORMATTED instead |
static ContentMode |
CONTENT_RAW
Deprecated. From 7.0, use ContentMode.RAW instead |
static ContentMode |
CONTENT_TEXT
Deprecated. From 7.0, use ContentMode.TEXT instead |
static ContentMode |
CONTENT_XHTML
Deprecated. From 7.0, use ContentMode.XHTML instead |
static ContentMode |
CONTENT_XML
Deprecated. From 7.0, use ContentMode.XML instead |
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
Label()
Creates an empty Label. |
|
Label(Property contentSource)
Creates a new instance of Label with text-contents read from given datasource. |
|
Label(Property contentSource,
ContentMode contentMode)
Creates a new instance of Label with text-contents read from given datasource. |
|
Label(String content)
Creates a new instance of Label with text-contents. |
|
Label(String content,
ContentMode contentMode)
Creates a new instance of Label with text-contents. |
Method Summary | |
---|---|
void |
addListener(Property.ValueChangeListener listener)
Adds the value change listener. |
int |
compareTo(Label other)
Compares the Label to other objects. |
protected void |
fireValueChange()
Emits the options change event. |
ContentMode |
getContentMode()
Gets the content mode of the Label. |
Converter<String,Object> |
getConverter()
Gets the converter used to convert the property data source value to the label value. |
Property |
getPropertyDataSource()
Gets the viewing data-source property. |
LabelState |
getState()
Returns the shared state bean with information to be sent from the server to the client. |
Class<String> |
getType()
Gets the type of the Property. |
String |
getValue()
Gets the value of the label. |
void |
removeListener(Property.ValueChangeListener listener)
Removes the value change listener. |
void |
setContentMode(ContentMode contentMode)
Sets the content mode of the Label. |
void |
setConverter(Converter<String,?> converter)
Sets the converter used to convert the label value to the property data source type. |
void |
setPropertyDataSource(Property newDataSource)
Sets the property as data-source for viewing. |
void |
setValue(Object newStringValue)
Set the value of the label. |
String |
toString()
Deprecated. Use getValue() instead |
void |
valueChange(Property.ValueChangeEvent event)
Listens the value change events from data source. |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.vaadin.data.Property |
---|
isReadOnly, setReadOnly |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
getExtensions, getStateType, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Field Detail |
---|
@Deprecated public static final ContentMode CONTENT_TEXT
ContentMode.TEXT
instead@Deprecated public static final ContentMode CONTENT_PREFORMATTED
ContentMode.PREFORMATTED
instead@Deprecated public static final ContentMode CONTENT_XHTML
ContentMode.XHTML
instead@Deprecated public static final ContentMode CONTENT_XML
ContentMode.XML
instead@Deprecated public static final ContentMode CONTENT_RAW
ContentMode.RAW
instead@Deprecated public static final ContentMode CONTENT_DEFAULT
ContentMode.TEXT
insteadConstructor Detail |
---|
public Label()
public Label(String content)
content
- public Label(Property contentSource)
contentSource
- public Label(String content, ContentMode contentMode)
content
- contentMode
- public Label(Property contentSource, ContentMode contentMode)
contentSource
- contentMode
- Method Detail |
---|
public LabelState getState()
AbstractComponent
getState
in interface Connector
getState
in interface Component
getState
in class AbstractComponent
public String getValue()
The value of the label is the text that is shown to the end user.
Depending on the ContentMode
it is plain text or markup.
getValue
in interface Property<String>
public void setValue(Object newStringValue)
setValue
in interface Property<String>
newStringValue
- the New value of the label.@Deprecated public String toString()
getValue()
instead
toString
in class Object
Object.toString()
public Class<String> getType()
getType
in interface Property<String>
Property.getType()
public Property getPropertyDataSource()
getPropertyDataSource
in interface Property.Viewer
Property.Viewer.getPropertyDataSource()
public void setPropertyDataSource(Property newDataSource)
setPropertyDataSource
in interface Property.Viewer
newDataSource
- the new data source PropertyProperty.Viewer.setPropertyDataSource(com.vaadin.data.Property)
public ContentMode getContentMode()
ContentMode
public void setContentMode(ContentMode contentMode)
contentMode
- the New content mode of the label.ContentMode
public void addListener(Property.ValueChangeListener listener)
addListener
in interface Property.ValueChangeNotifier
listener
- the Listener to be added.Property.ValueChangeNotifier.addListener(com.vaadin.data.Property.ValueChangeListener)
public void removeListener(Property.ValueChangeListener listener)
removeListener
in interface Property.ValueChangeNotifier
listener
- the Listener to be removed.Property.ValueChangeNotifier.removeListener(com.vaadin.data.Property.ValueChangeListener)
protected void fireValueChange()
public void valueChange(Property.ValueChangeEvent event)
valueChange
in interface Property.ValueChangeListener
event
- value change event objectProperty.ValueChangeListener.valueChange(Property.ValueChangeEvent)
public int compareTo(Label other)
Labels can be compared to other labels for sorting label contents. This is especially handy for sorting table columns.
In RAW, PREFORMATTED and TEXT modes, the label contents are compared as is. In XML, UIDL and XHTML modes, only CDATA is compared and tags ignored. If the other object is not a Label, its toString() return value is used in comparison.
compareTo
in interface Comparable<Label>
other
- the Other object to compare to.
Comparable.compareTo(java.lang.Object)
public Converter<String,Object> getConverter()
public void setConverter(Converter<String,?> converter)
converter
- The new converter to use.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |