com.vaadin.server
Interface LegacyComponent

All Superinterfaces:

ClientConnector, Component, com.vaadin.shared.Connector, java.util.EventListener, RpcTarget, java.io.Serializable, Sizeable, VariableOwner

All Known Implementing Classes:

AbstractSelect, AbstractTextField, Accordion, ComboBox, CustomLayout, DateField, DragAndDropWrapper, Embedded, Form, GridLayout, InlineDateField, Link, ListSelect, MenuBar, NativeSelect, OptionGroup, Panel, PasswordField, PopupDateField, PopupView, RichTextArea, Select, Table, TabSheet, TextArea, TextField, Tree, TreeTable, TwinColSelect, UI, UI.LegacyWindow, Upload, Window

public interface LegacyComponent
extends VariableOwner, Component, java.util.EventListener

Interface provided to ease porting of Vaadin 6 components to Vaadin 7. By implementing this interface your Component will be able to use paintContent(PaintTarget) and VariableOwner.changeVariables(Object, java.util.Map) just like in Vaadin 6.

Since:

7.0.0

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.VariableOwner

VariableOwner.ErrorEvent

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.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

void	markAsDirty() (non-Javadoc) Marks that this connector's state might have changed.
void	paintContent(PaintTarget target) Paints the Paintable into a UIDL stream.

Methods inherited from interface com.vaadin.server.VariableOwner

changeVariables, isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

beforeClientResponse, detach, encodeState, getExtensions, getStateType, handleConnectorRequest, isConnectorEnabled, markAsDirtyRecursive, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth

Method Detail

paintContent

void paintContent(PaintTarget target)
                  throws PaintException

Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.

It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.

Parameters:

target - the target UIDL stream where the component should paint itself to.

Throws:

PaintException - if the paint operation failed.

markAsDirty

void markAsDirty()

(non-Javadoc) Marks that this connector's state might have changed. When the framework is about to send new data to the client-side, it will run ClientConnector.beforeClientResponse(boolean) followed by ClientConnector.encodeState() for all connectors that are marked as dirty and send any updated state info to the client.

For a LegacyComponent, markAsDirty will also cause paintContent(PaintTarget) to be called before sending changes to the client.

Specified by:

markAsDirty in interface ClientConnector

See Also:

ClientConnector.markAsDirty()