Package org.web3d.x3d.sai.Layout
Interface ScreenFontStyle
- All Superinterfaces:
X3DFontStyleNode
,X3DNode
- All Known Implementing Classes:
ScreenFontStyle
ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification, and other styles used within a screen layout.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
ScreenFontStyle node tooltip: (X3D version 3.2 or later) [X3DFontStyleNode] ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification, and other styles used within a screen layout. ScreenFontStyle renders text so that it appears identical to typical 2D applications by specifying pointSize in points (as in 2D document layout) rather than size in meters. Each glyph of text is rendered as a quadrilateral with a texture applied.
- Hint: first add a Text node as a parent.
- Hint: Wikipedia https://en.wikipedia.org/wiki/Font
- Hint: Wikipedia https://en.wikipedia.org/wiki/Typeface
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput MFString field named family.boolean
Provide boolean value from inputOutput SFBool field named horizontal.String[]
Provide array of String enumeration results (baseType MFString) ['"MIDDLE"' | '"MIDDLE" "BEGIN"' | '"MIDDLE" "END"' | '"MIDDLE" "FIRST"' | '"MIDDLE" "MIDDLE"' | '"BEGIN"' | '"BEGIN" "BEGIN"' | '"BEGIN" "END"' | '"BEGIN" "FIRST"' | '"BEGIN" "MIDDLE"' | '"END"' | '"END" "BEGIN"' | '"END" "END"' | '"END" "FIRST"' | '"END" "MIDDLE"' | '"FIRST"' | '"FIRST" "BEGIN"' | '"FIRST" "END"' | '"FIRST" "FIRST"' | '"FIRST" "MIDDLE"'] from inputOutput MFString field named justify.Provide String value from inputOutput SFString field named language.boolean
Provide boolean value from inputOutput SFBool field named leftToRight.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pointSize.float
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named spacing.getStyle()
Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from inputOutput SFString field named style.boolean
Provide boolean value from inputOutput SFBool field named topToBottom.Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput MFString field named family.setHorizontal
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named horizontal.setJustify
(String[] newValue) Accessor method to assign String enumeration array (""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE"") to inputOutput MFString field named justify.setLanguage
(String newValue) Accessor method to assign String value to inputOutput SFString field named language.setLeftToRight
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named leftToRight.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setPointSize
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named pointSize.setSpacing
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named spacing.Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput SFString field named style.setTopToBottom
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named topToBottom.
-
Method Details
-
getFamily
String[] getFamily()Provide array of String enumeration results (baseType MFString) ['"SANS"' | '"SERIF"' | '"TYPEWRITER"' | '"etc."'] from inputOutput MFString field named family.
Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.- Hint: example family array might be "Times" "SERIF"
- Warning: font family support often varies.
- Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
- Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
- Hint: TYPEWRITER is a fixed-width font (for example, Courier).
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of family field
-
setFamily
Accessor method to assign String enumeration array (""SANS"" | ""SERIF"" | ""TYPEWRITER"") to inputOutput MFString field named family.
Tooltip: Array of quoted font family names in preference order, browsers use the first supported family.- Hint: example family array might be "Times" "SERIF"
- Warning: font family support often varies.
- Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
- Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
- Hint: TYPEWRITER is a fixed-width font (for example, Courier).
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the family field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHorizontal
boolean getHorizontal()Provide boolean value from inputOutput SFBool field named horizontal.
Tooltip: Whether text direction is horizontal (true) or vertical (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of horizontal field
-
setHorizontal
Accessor method to assign boolean value to inputOutput SFBool field named horizontal.
Tooltip: Whether text direction is horizontal (true) or vertical (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the horizontal field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJustify
String[] getJustify()Provide array of String enumeration results (baseType MFString) ['"MIDDLE"' | '"MIDDLE" "BEGIN"' | '"MIDDLE" "END"' | '"MIDDLE" "FIRST"' | '"MIDDLE" "MIDDLE"' | '"BEGIN"' | '"BEGIN" "BEGIN"' | '"BEGIN" "END"' | '"BEGIN" "FIRST"' | '"BEGIN" "MIDDLE"' | '"END"' | '"END" "BEGIN"' | '"END" "END"' | '"END" "FIRST"' | '"END" "MIDDLE"' | '"FIRST"' | '"FIRST" "BEGIN"' | '"FIRST" "END"' | '"FIRST" "FIRST"' | '"FIRST" "MIDDLE"'] from inputOutput MFString field named justify.
Tooltip: The justify field determines horizontal and vertical alignment of text layout, relative to the origin of the object coordinate system.- Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification horizontally and vertically.
- Warning: exactly two string values are provided for major and minor axis alignment.
- Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of justify field
-
setJustify
Accessor method to assign String enumeration array (""MIDDLE"" | ""MIDDLE" "BEGIN"" | ""MIDDLE" "END"" | ""MIDDLE" "FIRST"" | ""MIDDLE" "MIDDLE"" | ""BEGIN"" | ""BEGIN" "BEGIN"" | ""BEGIN" "END"" | ""BEGIN" "FIRST"" | ""BEGIN" "MIDDLE"" | ""END"" | ""END" "BEGIN"" | ""END" "END"" | ""END" "FIRST"" | ""END" "MIDDLE"" | ""FIRST"" | ""FIRST" "BEGIN"" | ""FIRST" "END"" | ""FIRST" "FIRST"" | ""FIRST" "MIDDLE"") to inputOutput MFString field named justify.
Tooltip: The justify field determines horizontal and vertical alignment of text layout, relative to the origin of the object coordinate system.- Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification horizontally and vertically.
- Warning: exactly two string values are provided for major and minor axis alignment.
- Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the justify field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLanguage
String getLanguage()Provide String value from inputOutput SFString field named language.
Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
- Hint: see RFC3066 Tags for the Identification of Languages https://tools.ietf.org/html/rfc3066
- Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of language field
-
setLanguage
Accessor method to assign String value to inputOutput SFString field named language.
Tooltip: Language codes consist of a primary code and a (possibly empty) series of subcodes. [ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved for language abbreviations. Two-letter primary codes include en (English), fr (French), de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese), ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur (Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
- Hint: see RFC3066 Tags for the Identification of Languages https://tools.ietf.org/html/rfc3066
- Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the language field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLeftToRight
boolean getLeftToRight()Provide boolean value from inputOutput SFBool field named leftToRight.
Tooltip: Whether text direction is left-to-right (true) or right-to-left (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of leftToRight field
-
setLeftToRight
Accessor method to assign boolean value to inputOutput SFBool field named leftToRight.
Tooltip: Whether text direction is left-to-right (true) or right-to-left (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the leftToRight field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DFontStyleNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DFontStyleNode
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getPointSize
float getPointSize()Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pointSize.
Tooltip: (0,+infinity) pointSize field specifies the size of text in points. Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.- Hint: pointSize replaces the size field of the FontStyle node.
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of pointSize field
-
setPointSize
Accessor method to assign float value to inputOutput SFFloat field named pointSize.
Tooltip: (0,+infinity) pointSize field specifies the size of text in points. Nominal height (in local coordinate system) of text glyphs, also sets default spacing between adjacent lines of text.- Hint: pointSize replaces the size field of the FontStyle node.
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the pointSize field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSpacing
float getSpacing()Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named spacing.
Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text.- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of spacing field
-
setSpacing
Accessor method to assign float value to inputOutput SFFloat field named spacing.
Tooltip: [0,+infinity) Adjustment factor for line spacing between adjacent lines of text.- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the spacing field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStyle
String getStyle()Provide String enumeration value (baseType xs:NMTOKEN) ["PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC"] from inputOutput SFString field named style.
Tooltip: Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).- Warning: overloaded name for CSS style attribute.
- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: overlapping functionality with CSS style attribute provides a "best of both worlds" approach. The style attribute provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
- Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Hint: CSS Snapshot https://www.w3.org/TR/css-2018
- Hint: https://www.w3.org/TR/css-style-attr
- Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
- Returns:
- value of style field
-
setStyle
Accessor method to assign String enumeration value ("PLAIN" | "BOLD" | "ITALIC" | "BOLDITALIC") to inputOutput SFString field named style.
Tooltip: Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).- Warning: overloaded name for CSS style attribute.
- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Fontfamilyandstyle for details.
- Hint: overlapping functionality with CSS style attribute provides a "best of both worlds" approach. The style attribute provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
- Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Hint: CSS Snapshot https://www.w3.org/TR/css-2018
- Hint: https://www.w3.org/TR/css-style-attr
- Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
- Parameters:
newValue
- is new value for the style field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTopToBottom
boolean getTopToBottom()Provide boolean value from inputOutput SFBool field named topToBottom.
Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Returns:
- value of topToBottom field
-
setTopToBottom
Accessor method to assign boolean value to inputOutput SFBool field named topToBottom.
Tooltip: Whether text direction is top-to-bottom (true) or bottom-to-top (false).- Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/text.html#Directionandjustification for details.
- Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
- Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
- Parameters:
newValue
- is new value for the topToBottom field.- Returns:
ScreenFontStyle
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-