Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #25

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,21 @@ A future-proof port of the `com.google.gwt.editor.Editor` GWT module, with no de
For Maven:

```xml
<dependency>
<groupId>org.gwtproject.editor</groupId>
<artifactId>gwt-editor</artifactId>
<version>HEAD-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.gwtproject.editor</groupId>
<artifactId>gwt-editor</artifactId>
<version>1.0.0-RC1</version>
</dependency>
```

and the processor:

```xml
<dependency>
<groupId>org.gwtproject.editor</groupId>
<artifactId>gwt-editor-processor</artifactId>
<version>HEAD-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.gwtproject.editor</groupId>
<artifactId>gwt-editor-processor</artifactId>
<version>1.0.0-RC1</version>
<scope>provided</scope>
</dependency>
```

For Gradle:
Expand Down Expand Up @@ -83,6 +82,7 @@ GWT Editor depends on the following module:

### the bean
```java
//Note place in *-shared directory
public class Person {

private int id;
Expand Down Expand Up @@ -129,6 +129,7 @@ public class Person {
> this component uses domino-ui

```java
//Note place in *-client directory
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe specify "client project or package", since not all projects follow that archetype

public class PersonComponent implements IsElement<HTMLDivElement>, Editor<Person> {

@IsDriver
Expand All @@ -137,6 +138,7 @@ public class PersonComponent implements IsElement<HTMLDivElement>, Editor<Person

private DominoElement<HTMLDivElement> root = DominoElement.of(div());

//Note: Do not create getter/setters for these fields - it will cause a compile issue such as "java.lang.IllegalStateException: generation aborted! No getter exists for >>getId<< -> [Help 1]"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably we should have a bug report for this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great feedback - updated thank you!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug Report Submitted
#26

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think, that there is a problem with the example. Please, take a look at my comment inside the issue.

IntegerBox id;
TextBox name;
CheckBox active;
Expand Down Expand Up @@ -171,8 +173,8 @@ public class PersonComponent implements IsElement<HTMLDivElement>, Editor<Person
}

@Override
public HTMLDivElement asElement() {
return root.asElement();
public HTMLDivElement element() {
return root.element();
}
}
```
Expand Down