org.nakedobjects.metamodel.facets.propparam.multiline
Interface MultiLineFacet

All Superinterfaces:

Facet, MultipleValueFacet

All Known Implementing Classes:

MultiLineFacetAbstract, MultiLineFacetAnnotation, MultiLineFacetNone

public interface MultiLineFacet
extends MultipleValueFacet

Whether the (string) property or parameter should be rendered over multiple lines.

In the standard Naked Objects Programming Model, corresponds to the @MultiLine annotation.

Method Summary

int	numberOfLines() How many lines to use.
boolean	preventWrapping() Whether carriage returns should be used to split over multiple lines or not.

Methods inherited from interface org.nakedobjects.metamodel.facets.Facet

alwaysReplace, facetType, getFacetHolder, getUnderlyingFacet, isDerived, isNoop, setFacetHolder, setUnderlyingFacet

Method Detail

numberOfLines

int numberOfLines()

How many lines to use.

preventWrapping

boolean preventWrapping()

Whether carriage returns should be used to split over multiple lines or not.

If set to true, then user must use carriage returns to split. If set to false, then the viewer should automatically wrap when spills over the length of one line.