यह क्या दिखाता है
Writing a component of your own — and the check to run before you do.
Search the inventory first. CrossFly is larger than it looks and its components are not discoverable by guessing; the reference app on this framework rebuilt a single-choice selector, a character limit and a grid column that all already existed, with the framework source compiled into its own build. A missing knob on an existing component is a smaller change than a new component, and it is the change the framework wants.
When nothing fits, a component is four decisions, and the one below makes all four.
- What it holds — plain fields, set through a fluent setter that returns
this, so it reads like every other widget. - How big it wants to be —
getAutoWidth/getAutoHeight, in font units, so it scales with density instead of being right on one screen. - What it looks like —
onPaint, taking every colour from a token so the theme and the skin reach it without a branch. - What a tap means —
onTouchUp, then tell the app through a callback. A component that acts on its own tap is a component that can only be used once.
अपनी मशीन पर चलाएँ
हर उदाहरण एक साधारण Window है, इसलिए लॉन्चर को सिर्फ़ उसका नाम चाहिए।
gradlew lwjgl3:run --args="classname dev.cf.recipe.R28Component"Java पहले से संकलित होता है, इसलिए ब्राउज़र आपके बदलाव को खुद दोबारा नहीं बना सकता — यहाँ दिखा कोड प्रकाशित होने से पहले TeaVM द्वारा JavaScript में बदला गया था। फ़ाइल को किसी प्रोजेक्ट में कॉपी कीजिए और वह चारों प्लेटफ़ॉर्म पर बिना बदलाव चलती है; ऊपर दी गई कमांड ही पूरी तैयारी है।
यह क्या इस्तेमाल करता है
इस उदाहरण में छुए गए फ़्रेमवर्क टाइप। जिनमें लिंक है उनका संदर्भ पृष्ठ मौजूद है।
सोर्स कोड
पूरा, बिना कटौती के। यह वही फ़ाइल है, उसका अंश नहीं।
package dev.cf.recipe;
import dev.cf.Tones;
import dev.crossfly.ui.*;
import dev.crossfly.ui.color.*;
import dev.crossfly.ui.color.PalColor;
import dev.crossfly.ui.graphics.*;
import dev.crossfly.ui.layout.*;
import dev.crossfly.ui.style.*;
import static dev.crossfly.ui.Widgets.*;
/**
* Writing a component of your own — and the check to run before you do.
*
* <p><b>Search the inventory first.</b> CrossFly is larger than it looks and its components are not
* discoverable by guessing; the reference app on this framework rebuilt a single-choice selector, a
* character limit and a grid column that all already existed, with the framework source compiled
* into its own build. A missing knob on an existing component is a smaller change than a new
* component, and it is the change the framework wants.</p>
*
* <p>When nothing fits, a component is four decisions, and the one below makes all four.</p>
*
* <ol>
* <li><b>What it holds</b> — plain fields, set through a fluent setter that returns {@code this},
* so it reads like every other widget.</li>
* <li><b>How big it wants to be</b> — {@code getAutoWidth}/{@code getAutoHeight}, in font units,
* so it scales with density instead of being right on one screen.</li>
* <li><b>What it looks like</b> — {@code onPaint}, taking every colour from a token so the theme
* and the skin reach it without a branch.</li>
* <li><b>What a tap means</b> — {@code onTouchUp}, then tell the app through a callback. A
* component that acts on its own tap is a component that can only be used once.</li>
* </ol>
*/
public class R28Component extends Recipe
{
private Label chosen;
public String title()
{
return "Writing your own component";
}
public String note()
{
return "Search dev/crossfly/ui first — most of what you are about to write is already there."
+ " When it genuinely is not, this is the shape.";
}
public void build(Component body) throws Exception
{
chosen = label("Nothing rated yet.", 1.5f, true, Tones.accent(), Position.START);
body.add(LAY_AUTO, outgap(chosen, 0, 0, 0, .8f));
Rating r = new Rating().stars(5)
.value(3)
.onChange(v ->
{
chosen.setText(v + " of 5");
chosen.setValidLayout(false);
Screen.repaint();
});
r.testTag("recipe.rating");
body.add(LAY_AUTO, r);
body.add(LAY_AUTO, outgap(label("Tap a star. The component reports the number and does"
+ " nothing else with it — which is what lets the same class drive a filter here and a"
+ " form field somewhere else.", 1f, false, Styles.captionColor, Position.START), 0, 1f, 0,
0));
}
/** A row of stars: pick a value from one to N. */
private static class Rating extends Component
{
/** Material star and star_border. */
private static final String FILLED = "", EMPTY = "";
private int stars = 5, value;
private RunnableWithInt onChange;
/** Glyphs and the shape are FIELDS: onPaint runs every frame and must not allocate. */
private final MaterialIcon on = new MaterialIcon(FILLED, 1.6f),
off = new MaterialIcon(EMPTY, 1.6f);
Rating stars(int n)
{
stars = n;
return this;
}
Rating value(int v)
{
value = v;
return this;
}
Rating onChange(RunnableWithInt r)
{
onChange = r;
return this;
}
/** One star per slot, square, sized from the font like everything else. */
private int slot()
{
return Math.round(Styles.fontHeight * 2f);
}
@Override
public int getAutoWidth()
{
return slot() * stars;
}
@Override
public int getAutoHeight()
{
return slot();
}
@Override
public void onPaint(Paint paint) throws Exception
{
int s = slot();
for (int i = 0; i < stars; i++)
{
MaterialIcon g = i < value ? on : off;
// Colour from a token, never a literal: this is what makes the component correct in
// dark mode and under every skin without knowing which one is in force.
PalColor tone = i < value ? Styles.primaryColor : Styles.captionColor;
// drawCentered takes the CENTRE, so the glyph's own metrics stay the icon's business.
g.drawCentered(paint, i * s + s / 2, height / 2, tone.color());
}
}
/**
* A tap picks a star and REPORTS it. It does not decide what that means — the screen does,
* and that separation is the whole reason this class is reusable.
*/
@Override
public void onTouchUp(float x, float y, int button) throws Exception
{
int picked = Math.min(stars, Math.max(1, (int) (x / slot()) + 1));
if (picked != value)
{
value = picked;
if (onChange != null)
onChange.run(picked);
Screen.repaint();
}
}
}
/** A one-method callback carrying an int — the framework's RunnableWith, narrowed. */
private interface RunnableWithInt
{
void run(int value);
}
}package dev.cf.recipe;
import dev.cf.*;
import dev.crossfly.ui.*;
import dev.crossfly.ui.graphics.*;
import dev.crossfly.ui.layout.*;
import dev.crossfly.ui.skin.*;
import dev.crossfly.ui.style.*;
import static dev.crossfly.ui.Widgets.*;
/**
* Base of a <b>recipe</b>: one screen that shows one thing, and nothing else.
*
* <p>A recipe is not a sample. A sample shows a component with all its knobs; a recipe answers a
* question somebody actually has — "how do I put a filter sheet over a list?", "how do I make this
* follow the theme?" — in as few lines as it takes, so the answer can be read in one screen and
* copied without editing.</p>
*
* <p>That is the whole design constraint: <b>the boilerplate lives here, the substance lives in the
* subclass.</b> A recipe that spends twenty lines building a title bar teaches the title bar.</p>
*
* <p>Write one as:</p>
*
* <pre>
* public class MyRecipe extends Recipe
* {
* public String title() { return "What this shows"; }
* public String note() { return "The one sentence worth knowing."; }
*
* public void build(Component body) throws Exception
* {
* body.add(LAY_AUTO, new Button("Tap"));
* }
* }
* </pre>
*/
public abstract class Recipe extends SampleWindow implements Described
{
@Override
public abstract String title();
/**
* The one thing a reader should take away — printed above the recipe, in caption tone.
*
* @return the note, or null for none
*/
@Override
public String note()
{
return null;
}
/**
* Builds the recipe.
*
* @param body a vertical, scrollable container with sensible padding — add to it and stop
* @throws Exception when building fails
*/
public abstract void build(Component body) throws Exception;
@Override
public void onAdd(boolean firstTime) throws Exception
{
addTopBar(title());
// The page, not the surface. addTopBar just set fullscreenColor to the surface,
// and on a white page a white card has no edges — see Tones.page(). Re-derived on restyle so
// a dark-mode flip does not leave the light page behind.
fullscreenColor = Tones.page();
onRestyle(() -> fullscreenColor = Tones.page());
contents.setLayout(new VerticalLayout(Position.START, Position.START));
contents.getStyle()
.ingap(Gap.ofFont(1f, 1f, 1f, 1f));
String n = note();
if (n != null)
contents.add(LAY_AUTO, outgap(nota(n), 0, 0, 0, 1f));
Component body = new Component();
body.setLayout(new VerticalLayout(Position.START, Position.START));
body.setScrollable(ScrollDirection.VERTICAL);
body.testTag("recipe.body");
contents.add(LAY_FILL, body);
build(body);
if (pinned != null)
{
// Measured again once its labels have sizes: the band's AUTO height is taken in the first
// layout, before them, and on the iPhone it showed only its first line - the odometer's
// "No text recognizer on this device." was set and never seen (17/10/2026).
final Component band = pinned;
onUI(band::invalidateMeasure);
}
if (pinned != null)
body.add(LAY_AUTO, new Component()
{
@Override
public int getAutoHeight()
{
// Room for the last row to scroll clear of the floating band.
return pinned.getAutoHeight();
}
});
}
/**
* The note, as a tinted band rather than three lines of grey.
*
* <p>It is the one sentence the reader is meant to leave with, and it used to be the least
* legible thing on the screen: caption-coloured, caption-sized, indistinguishable from the
* captions further down that are only labels. A tone and a glyph cost nothing here — nobody has
* to read the band to know what it is.</p>
*
* @param n the note text
* @return the band
* @throws Exception when building fails
*/
/**
* Pins {@code c} to the bottom of the screen, in a band that FLOATS over the scrolling body: it
* stays on screen however far the body is scrolled, and the body scrolls underneath it. That is the
* place a recipe says what just happened. An answer at the top of the body went out of view as soon
* as the person scrolled down to the button that produced it (14/10/2026).
* <p>
* The band is 80% OPAQUE (the surface at alpha 0xCC), as the user asked; it floats rather than
* sitting below the body because a transparency with nothing behind it cannot be seen -- the first
* version had the band under the body, and the person saw a plain bar. The body gets a spacer as
* tall as the band at its end, so its last row can still scroll clear of it.
*
* @param c the component to pin, usually the answer label
* @return {@code c}, to chain
* @throws Exception if the layout refuses
*/
protected <T extends Component> T pin(T c) throws Exception
{
Component band = new Component();
band.setLayout(new VerticalLayout(Position.START, Position.START));
band.style(Skin.get()
.card()
.backColor(Styles.backColor.withAlpha(0xCC))
.borderColor(Styles.borderColor.withAlpha(0x33))
.borderRadius(0)
.shadow(0, 0, 0, 0)
.ingap(Gap.ofFont(1f, 1f, 1f, 1.2f))
.outgap(Gap.ofFont(0)));
band.add(LAY_AUTO, c);
// Floated: positioned at the bottom, full width, over whatever the body has there.
band.setRelativeBounds(Relative.START, Relative.END, Relative.FULL, Relative.AUTO);
contents.add(LAY_AUTO, band);
pinned = band;
return c;
}
/** The floating band {@link #pin} made, or null; the body ends in a spacer as tall as it. */
private Component pinned;
private Component nota(String n) throws Exception
{
Component band = new Component();
band.setLayout(new GridLayout(Position.START, Position.START));
band.style(Skin.get()
.card()
.backColor(Tones.accent().withAlpha(0x16))
.borderColor(Tones.accent().withAlpha(0x4A))
.shadow(0, 0, 0, 0)
.outgap(Gap.ofFont(0)));
// 0xE88E is the outlined "info". The glyph column hugs; the text takes the rest and wraps.
// The weights are GridLayout's own — 0f hugs, 1f takes what is left. LAY_FILL belongs to the
// vertical and horizontal layouts and means nothing here: it collapsed the text to nothing.
band.add(LAY_AUTO, 1f, matglyph(0xE88E, Tones.accent(), 1.05f),
outgap(label(n, 1f, false, secondary(), Position.START), .5f, 0, 0, 0));
return band;
}
}package dev.cf;
import dev.crossfly.ui.*;
import dev.crossfly.ui.graphics.*;
import dev.crossfly.ui.layout.*;
import dev.crossfly.ui.style.*;
import static dev.cf.sample.CrossFlySamplesColors.*;
/**
* Base class for all CrossFly sample windows.
* <p>
* Provides common infrastructure:
* <ul>
* <li>Shared color palette and styles from {@link dev.cf.sample.CrossFlySamplesColors}</li>
* <li>{@link #addTopBar(String, Button...)} — standard deep-indigo top bar with back button</li>
* <li>{@link #barButton(String, Runnable)} — helper to create icon buttons for the bar</li>
* </ul>
*
* <h3>Usage</h3>
* <pre>
* public class MySample extends SampleWindow {
* public void onAdd(boolean firstTime) throws Exception {
* if (!firstTime) return;
* initWindow();
* addTopBar("My Sample");
* // ... add content
* }
* }
* </pre>
*/
public abstract class SampleWindow extends Window
{
/** The main content area of the window, added by {@link #addTopBar(String, Button...)}, for subclasses to add their content into. */
protected Component contents;
// ─── Top bar ─────────────────────────────────────────────────────────────
/**
* Builds and adds a standard top bar with a back (←) button on the left,
* a centered title, and any optional extra buttons on the right.
*
* @param title the text shown in the bar
* @param rightButtons zero or more icon buttons placed aligned to the right
* @throws Exception if component construction fails
*/
protected void addTopBar(String title, Button... rightButtons) throws Exception
{
fullscreenColor = Styles.backColor.color();
setLayout(new VerticalLayout());
add(0f, buildTopBar(title, rightButtons));
add(LAY_FILL, contents = new Component());
contents.getStyle()
.ingap(Gap.ofFont(0, .5f, 0, .5f));
}
/**
* Same as {@link #addTopBar(String, Button...)}, but returns the bar component
* instead of adding it, for callers that need to position it manually.
*
* @param title the bar title
* @param rightButtons optional right-side icon buttons
* @return the assembled top-bar {@link Component}
* @throws Exception if component construction fails
*/
protected Component buildTopBar(String title, Button... rightButtons) throws Exception
{
Button btBack = barButton("\ue5c4", this::hide); // arrow_back
btBack.testTag("sample.back");
// Padded on every side, like the bar's right buttons: with none above and below, the target
// was the arrow itself, too small to hit on a small phone (iPhone 5s, 17/10/2026).
btBack.getStyle()
.ingap(Gap.ofFont(.75f))
.outgap(Gap.ofFont(0, 0, .25f, 0));
Component bar = new Component().style(barStyle);
bar.setLayout(new GridLayout(Position.START, Position.CENTER));
int n = 2 + rightButtons.length;
Object[] params = new Object[n * 2];
params[0] = 0f;
params[1] = 1f;
for (int i = 0; i < rightButtons.length; i++)
params[2 + i] = 0f;
params[n] = btBack;
params[n + 1] = new Label(title).style(barTitleStyle);
for (int i = 0; i < rightButtons.length; i++)
{
params[n + 2 + i] = rightButtons[i];
rightButtons[i].getStyle()
.ingap(Gap.ofFont(.75f));
}
bar.add(params);
return bar;
}
/**
* Creates a standard bar icon button (transparent, white icon, pressed feedback).
*
* @param materialIcon the Material Icon unicode codepoint string
* @param action the action to run when the button is tapped
* @return the configured {@link Button}
*/
protected Button barButton(String materialIcon, Runnable action)
{
return new Button(new MaterialIcon(materialIcon)).style(barButtonNormal)
.pressedStyle(barButtonPressed)
.onAction(e -> action.run());
}
}इस पृष्ठ के मशीन-पठनीय रूप, ताकि मॉडल API का अनुमान लगाने के बजाय उदाहरण पढ़ सके।