Java Doc for ItsNatLabel.java in  » Ajax » ItsNat » org » itsnat » comp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Ajax » ItsNat » org.itsnat.comp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.itsnat.comp.ItsNatLabel

All known Subclasses:   org.itsnat.impl.comp.ItsNatLabelImpl,
ItsNatLabel
public interface ItsNatLabel extends ItsNatElementComponent(Code)
Is the base interface of label components.

A label component contains a single object value, this value is rendered as markup using a special object, the renderer, and may be optionally edited "in place" using a user defined editor.

Any change to the internal value is notified with a "value" property change event and may be vetoed (see ItsNatLabel.setValue(Object) . The new value, if accepted, is rendered as markup.

This component family is the "componentized" version of org.itsnat.core.domutil.ElementLabel and follows a similar philosophy.


author:
   Jose Maria Arranz Santamaria




Method Summary
public  StringgetEditorActivatorEvent()
     Returns the event type used to activate the label edition process by the user. the event type used to activate the edition.
public  ItsNatLabelEditorgetItsNatLabelEditor()
     Returns the current label editor.
public  ItsNatLabelRenderergetItsNatLabelRenderer()
     Returns the current component renderer.
public  ItsNatLabelUIgetItsNatLabelUI()
     Returns the user interface manager of this component.
public  ObjectgetValue()
     Returns the current value.
public  booleanisEditing()
     Informs whether the label value is being edited.
public  voidsetEditorActivatorEvent(String eventType)
     Sets the event type used to activate the label edition process by the user.
public  voidsetItsNatLabelEditor(ItsNatLabelEditor editor)
     Sets the label editor.

This component automatically adds a listener calling javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener) this way the component is informed when the editor stops or cancels editing.

The edition process starts programmatically by calling ItsNatLabel.startEditing() or by user action (usually double clicking the label or the action/event type specified by ItsNatLabel.getEditorActivatorEvent() ).

public  voidsetItsNatLabelRenderer(ItsNatLabelRenderer renderer)
     Sets the component renderer.
public  voidsetValue(Object value)
     Sets the value.
public  voidstartEditing()
     Used to start programmatically the label edition process "in place".



Method Detail
getEditorActivatorEvent
public String getEditorActivatorEvent()(Code)
Returns the event type used to activate the label edition process by the user. the event type used to activate the edition. By default is "dblclick".
See Also:   ItsNatLabel.setEditorActivatorEvent(String)



getItsNatLabelEditor
public ItsNatLabelEditor getItsNatLabelEditor()(Code)
Returns the current label editor. This object is used to edit in place the current label value. the current editor. By default uses the default editor calling (ItsNatComponentManager.createDefaultItsNatLabelEditor(ItsNatComponent)) with a null parameter.
See Also:   ItsNatLabel.setItsNatLabelEditor(ItsNatLabelEditor)



getItsNatLabelRenderer
public ItsNatLabelRenderer getItsNatLabelRenderer()(Code)
Returns the current component renderer. This renderer converts the label value to markup. the current renderer. By default uses the default renderer (ItsNatComponentManager.createDefaultItsNatLabelRenderer)
See Also:   ItsNatLabel.setItsNatLabelRenderer(ItsNatLabelRenderer)



getItsNatLabelUI
public ItsNatLabelUI getItsNatLabelUI()(Code)
Returns the user interface manager of this component. the user interface manager.



getValue
public Object getValue()(Code)
Returns the current value. the current value. The default value is null.



isEditing
public boolean isEditing()(Code)
Informs whether the label value is being edited. true if the label is being edited.
See Also:   ItsNatLabel.startEditing()



setEditorActivatorEvent
public void setEditorActivatorEvent(String eventType)(Code)
Sets the event type used to activate the label edition process by the user.
Parameters:
  eventType - the event type used to activate the edition.
See Also:   ItsNatLabel.getEditorActivatorEvent()
See Also:   



setItsNatLabelEditor
public void setItsNatLabelEditor(ItsNatLabelEditor editor)(Code)
Sets the label editor.

This component automatically adds a listener calling javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener) this way the component is informed when the editor stops or cancels editing.

The edition process starts programmatically by calling ItsNatLabel.startEditing() or by user action (usually double clicking the label or the action/event type specified by ItsNatLabel.getEditorActivatorEvent() ). Then the label markup (below the parent element) is removed and the method ItsNatLabelEditor.getLabelEditorComponent(ItsNatLabelObjectElement) is called, this method usually places the editor component inside the label. Current label implementations do nothing with the editor component returned and may be null.

When the editor stops the component calls CellEditor.getCellEditorValue() to obtain the new value and sets this value to the label (calling ItsNatLabel.setValue(Object) ) and the editor is removed and the original label markup is restored modified by the renderer with the new value. If the editor is cancelled all is the same but no markup change is made.


Parameters:
  editor - the new editor. May be null (edition disabled).
See Also:   ItsNatLabel.getItsNatLabelEditor()
See Also:   



setItsNatLabelRenderer
public void setItsNatLabelRenderer(ItsNatLabelRenderer renderer)(Code)
Sets the component renderer.
Parameters:
  renderer - the new renderer.
See Also:   ItsNatLabel.getItsNatLabelRenderer()
See Also:   



setValue
public void setValue(Object value) throws PropertyVetoException(Code)
Sets the value. The new value will be rendered automatically to markup.

This new value is "voted" before is set firing a java.beans.PropertyChangeEvent event, with name "value", sent to the listeners registered with ItsNatComponent.addVetoableChangeListener(VetoableChangeListener) if some listener does a "veto" (throws a java.beans.PropertyVetoException) the new value is not set. If finally set the PropertyChangeEvent event is sent to the listeners registered with ItsNatComponent.addPropertyChangeListener(java.beans.PropertyChangeListener) or ItsNatComponent.addPropertyChangeListener(Stringjava.beans.PropertyChangeListener) with property name "value".


Parameters:
  value - value to display (and may be edit).
throws:
  PropertyVetoException - if the new value was vetoed.



startEditing
public void startEditing()(Code)
Used to start programmatically the label edition process "in place".
See Also:   ItsNatLabel.isEditing()



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.