case class SelectionConfig(name: String, choices: NonEmptyChain[ChoiceConfig], separateEbooks: Boolean = false) extends Product with Serializable
Configuration for a single kind of selection and its choices available for the user.
- name
the name of the selection as used in text markup, e.g.
@:select(name).- choices
the configuration for one or more choices that are available in each of the directives
- separateEbooks
whether the selection should render all its choices in the same output or produce separate e-books where in each of them only one of the choice is displayed. This way separate e-books for Scala vs. Java code samples or sbt vs. Maven build examples can be produced. Keep in mind that multiple selections having this property set to true would result in the cartesian product of available e-book versions, it is therefore unusual to have more than one or two.
- Alphabetic
- By Inheritance
- SelectionConfig
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
SelectionConfig(name: String, choices: NonEmptyChain[ChoiceConfig], separateEbooks: Boolean = false)
- name
the name of the selection as used in text markup, e.g.
@:select(name).- choices
the configuration for one or more choices that are available in each of the directives
- separateEbooks
whether the selection should render all its choices in the same output or produce separate e-books where in each of them only one of the choice is displayed. This way separate e-books for Scala vs. Java code samples or sbt vs. Maven build examples can be produced. Keep in mind that multiple selections having this property set to true would result in the cartesian product of available e-book versions, it is therefore unusual to have more than one or two.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val choices: NonEmptyChain[ChoiceConfig]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getLabel(name: String): Option[String]
Returns the label of the choice with the specified name, if present.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
select(choice: ChoiceConfig): SelectionConfig
Returns a copy of this instance where the specified choice is marked as selected.
- val separateEbooks: Boolean
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withSeparateEbooks: SelectionConfig
Specifies that the choices of this selection should be rendered in entirely separate e-books and not below each other in the same output.
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated