Skip to content

Commit b046451

Browse files
mlopezFCjavier-godoy
authored andcommitted
docs: improve some javadocs
1 parent dcaa58b commit b046451

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

src/main/java/com/flowingcode/addons/applayout/AppLayout.java

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,28 +135,44 @@ public boolean isMenuVisible() {
135135
return this.getElement().getProperty("drawerVisible", true);
136136
}
137137

138-
/** Set the toolbar title */
139-
public void setCaption(String caption) {
140-
this.getElement().setAttribute(TITLE_ATTRIBUTE_NAME, caption);
141-
}
142-
143138
@Override
144139
public void configurePage(InitialPageSettings settings) {
145140
settings.addMetaTag("viewport", "width=device-width, initial-scale=1.0");
146141
}
147142

148-
/** Mantains the header fixed at the top so it never moves away. */
143+
/**
144+
* Sets the toolbar title
145+
* @param caption
146+
*/
147+
public void setCaption(String caption) {
148+
this.getElement().setAttribute(TITLE_ATTRIBUTE_NAME, caption);
149+
}
150+
151+
/**
152+
* Sets the fixed attribute so it mantains the header fixed at the top
153+
* so it never moves away.
154+
* @param fixed
155+
*/
149156
public void setFixed(boolean fixed) {
150157
this.getElement().setAttribute("fixed", fixed);
151158
}
152159

153-
/** Slides back the header when scrolling back up. */
160+
/**
161+
* Sets the reveals attribute so it slides back the header when scrolling
162+
* back up.
163+
* @param reveals
164+
*/
154165
public void setReveals(boolean reveals) {
155166
this.getElement().setAttribute("reveals", reveals);
156167
}
157168

158-
/** Create an area at the edge of the screen to swipe open the app-drawer */
169+
/**
170+
* Sets the swipeOpen attribute so it creates an area at the edge of the
171+
* screen to swipe open the app-drawer
172+
* @param swipeOpen
173+
*/
159174
public void setSwipeOpen(boolean swipeOpen) {
160175
this.getElement().setAttribute("swipeOpen", swipeOpen);
161176
}
177+
162178
}

0 commit comments

Comments
 (0)