Package muntjac :: Package addon :: Package colorpicker :: Module color_picker_gradient :: Class ColorPickerGradient

Class ColorPickerGradient

                          object --+                
                                   |                
                 util.IEventListener --+            
                                       |            
           terminal.paintable.IPaintable --+        
                                           |        
                              object --+   |        
                                       |   |        
  terminal.variable_owner.IVariableOwner --+        
                                           |        
                              object --+   |        
                                       |   |        
             terminal.sizeable.ISizeable --+        
                                           |        
                     ui.component.IComponent --+    
                                               |    
                                  object --+   |    
                                           |   |    
event.method_event_source.IMethodEventSource --+    
                                               |    
         ui.abstract_component.AbstractComponent --+
                                                   |
                                      object --+   |
                                               |   |
                   color_selector.IColorSelector --+
                                                   |
                                                  ColorPickerGradient

The Class ColorPickerGradient.

Authors:: John Ahlroos, Richard Lincoln

Instance Methods

[hide private]

__init__(self, Id, converter)
Instantiates a new color picker gradient.

source code

setColor(self, c)
Sets the color.

source code

paintContent(self, target)
Paints any needed component-specific things to the given UIDL stream.

source code

changeVariables(self, source, variables)
Called when one or more variables handled by the implementing class are changed.

source code

addListener(self, listener, iface=None)
Registers a new (generic) component event listener for the component:

source code

addCallback(self, callback, eventType=None, *args)

source code

removeListener(self, listener, iface=None)
Removes a previously registered component event listener from this component.

source code

removeCallback(self, callback, eventType=None)

source code

setBackgroundColor(self, color)
Sets the background color.

source code

getColor(self)
Gets the color.

source code

fireColorChanged(self, color)
Notifies the listeners that the color has changed

source code

Inherited from ui.abstract_component.AbstractComponent: __getstate__, __setstate__, addStyleName, attach, childRequestedRepaint, detach, fireComponentErrorEvent, fireComponentEvent, fireEvent, fireRequestRepaintEvent, focus, getApplication, getCSSHeight, getCSSWidth, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, parseStringSize, registerCallback, registerListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidthUnits, withdrawCallback, withdrawListener

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

CLIENT_WIDGET = None
hash(x)

TYPE_MAPPING = 'com.vaadin.addon.colorpicker.ColorPickerGradient'

Inherited from ui.abstract_component.AbstractComponent: SIZE_PATTERN

Inherited from terminal.sizeable.ISizeable: SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNIT_SYMBOLS

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, Id, converter)
(Constructor)

source code

Instantiates a new color picker gradient.

Parameters:

id - the id
converter - the converter

Overrides: object.__init__

setColor(self, c)

source code

Sets the color.

Parameters:

color - the new color

Overrides: color_selector.IColorSelector.setColor

(inherited documentation)

paintContent(self, target)

source code

Paints any needed component-specific things to the given UIDL stream. The more general paint method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Parameters:

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

Raises:

PaintException - if the paint operation failed.

Overrides: ui.abstract_component.AbstractComponent.paintContent

(inherited documentation)

changeVariables(self, source, variables)

source code

Called when one or more variables handled by the implementing class are changed.

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
variables - the Mapping from variable names to new variable values.

Overrides: terminal.variable_owner.IVariableOwner.changeVariables

(inherited documentation)

addListener(self, listener, iface=None)

source code

Registers a new (generic) component event listener for the component:

 class Listening(CustomComponent, IListener):

     # Stored for determining the source of an event
     ok = None

     status = None  # For displaying info about the event

     def __init__(self):
         layout = VerticalLayout()

         # Some miscellaneous component
         name = TextField("Say it all here")
         name.addListener(self)
         name.setImmediate(true)
         layout.addComponent(name)

         # Handle button clicks as generic events instead
         # of Button.ClickEvent events
         ok = new Button("OK")
         ok.addListener(self)
         layout.addComponent(ok)

         # For displaying information about an event
         status = new Label("")
         layout.addComponent(status)

         setCompositionRoot(layout)


     def componentEvent(event):
         # Act according to the source of the event
         if (event.getSource() == ok):
             getWindow().showNotification("Click!")

         status.setValue("Event from " +
                 event.getSource().__class__.__name__
                 + ": " + event.__class__.__name__)


 listening = Listening()
 layout.addComponent(listening)

Parameters: